diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2017-03-28 23:35:03 -0300 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2017-03-28 23:35:03 -0300 |
| commit | df9fb04f87dde125e828c9956db70e25d3ca2a1f (patch) | |
| tree | 2089f708f1793099d1b27a54527dfdbd6cbe9c19 /doc/development/doc_styleguide.md | |
| parent | dd4893513f977e9e4d76d921426e34e96161dcf3 (diff) | |
| download | gitlab-ce-df9fb04f87dde125e828c9956db70e25d3ca2a1f.tar.gz | |
add link to "writing docs" , fix typo
Diffstat (limited to 'doc/development/doc_styleguide.md')
| -rw-r--r-- | doc/development/doc_styleguide.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 3c755c192fa..bb78a0de0c5 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -3,6 +3,8 @@ This styleguide recommends best practices to improve documentation and to keep it organized and easy to find. +See also [writing documentation](writing_documentation.md). + ## Location and naming of documents >**Note:** @@ -59,7 +61,7 @@ The table below shows what kind of documentation goes where. located at `doc/user/admin_area/settings/visibility_and_access_controls.md`. 1. The `doc/topics/` directory holds topic-related technical content. Create `doc/topics/topic-name/subtopic-name/index.md` when subtopics become necessary. - Note that `topics` holds the index page per topic, and techical articles. General + Note that `topics` holds the index page per topic, and technical articles. General user- and admin- related documentation, should be placed accordingly. --- |