Skip to content

Commit d4dfdaf

Browse files
authored
docs: Update HOW_WE_WRITE_DOCS.md (#6850)
1 parent 4a5329c commit d4dfdaf

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

docs/HOW_WE_WRITE_DOCS.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,32 @@ To keep docs consistent and easily-searchable, follow these grammar guidelines:
5757
* Use numbered bullets when the order is important, such as steps in a guide or hierarchies of dependencies
5858
* Write with [active voice](https://www.grammarly.com/blog/active-vs-passive-voice/) in tutorials and how-tos, and passive voice in explanations
5959
* Use the [Oxford comma](https://www.grammarly.com/blog/what-is-the-oxford-comma-and-why-do-people-care-so-much-about-it/)
60-
* Avoid exclamation points
60+
* Avoid exclamation points
61+
62+
# Docusaurus and discoverability
63+
64+
## URLs
65+
66+
Markdown links by file (with extension).
67+
Can be relative to current path (`./`, `../`), eg within a section, or absolute (relative to docs).
68+
[link1](https://docusaurus.io/docs/markdown-features/links), [link2](https://docusaurus.io/docs/versioning#link-docs-by-file-paths)
69+
70+
If you spot a broken url, ping us in discord or create an issue :)
71+
72+
## Keywords
73+
74+
"Used by search engines" - [link](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages#keywords)
75+
Used to help devs better find specific content via search.
76+
77+
## Tags
78+
79+
"Another dimension of categorization" - [link](https://docusaurus.io/docs/create-doc#doc-tags)
80+
Used sparingly to help devs see related contact across docs.
81+
82+
## Sidebar
83+
84+
The Aztec docs use a sidebar - https://docusaurus.io/docs/sidebar/items
85+
86+
## Indexing and Search
87+
88+
Algolia docs search - https://docusaurus.io/docs/search#algolia-index-configuration

0 commit comments

Comments
 (0)