Documentation Style
Here’s a collection of styles. And musings
Writing Style
Section titled “Writing Style”We prefer enough information, but not superfluous information. Overly verbose docs lead to folks not digesting the information due to context overload. Don’t use asides too much as an example.
We also prefer that the docs are human written. Yes, you can probably whip something out real quick like via Ai, but we think it misses the human aspect then. We do think that AI can be helpful to generate a new doc page or section, but not actually write the content.
Docs should be added as .mdx.
Titles
Section titled “Titles”Use an icon after headings to help separate the sections.
rocket for reference.
Section titled “rocket for reference.”<Icon name="rocket" />open-book for guides.
Section titled “open-book for guides.”<Icon name="open-book" />star for products.
Section titled “star for products.”<Icon name="star" />