Commit df9fb04f authored by Marcia Ramos's avatar Marcia Ramos

add link to "writing docs" , fix typo

parent dd489351
...@@ -3,6 +3,8 @@ ...@@ -3,6 +3,8 @@
This styleguide recommends best practices to improve documentation and to keep This styleguide recommends best practices to improve documentation and to keep
it organized and easy to find. it organized and easy to find.
See also [writing documentation](writing_documentation.md).
## Location and naming of documents ## Location and naming of documents
>**Note:** >**Note:**
...@@ -59,7 +61,7 @@ The table below shows what kind of documentation goes where. ...@@ -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`. located at `doc/user/admin_area/settings/visibility_and_access_controls.md`.
1. The `doc/topics/` directory holds topic-related technical content. Create 1. The `doc/topics/` directory holds topic-related technical content. Create
`doc/topics/topic-name/subtopic-name/index.md` when subtopics become necessary. `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. user- and admin- related documentation, should be placed accordingly.
--- ---
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment