<aside> 👍 Easily contribute to the Builder DAO / Kafé documentation with this short style guide.

When you’re ready to contribute to the docs, please do so via a pull request to the dev branch of the Kafé repository. 🐌 Staging docs are deployed at https://docs.dev.builderdao.io 🚀 Production docs are deployed at https://docs.builderdao.io

</aside>

Frontmatter

Basic Template

Document Location

Builder DAO / Kafé documentation is located in the Kafé repository under the apps/docs/pages directory and uses the .mdx file extension to enable React components as defined in apps/docs/components.

kafe/apps/docs/pages at dev · TheBuilderDAO/kafe

Example of complete documentation:

Document Structure

<aside> 💡 Remember to use a .mdx file extension!

</aside>

• The page title as it appears on a browser tab is defined in the frontmatter of the document and should match the title of the document as it appears at the top of the page.

  ---
  title: Digital Architecture
  ---
  

• Import the Authors component and Author at the beginning of the file:

  import Authors, { Author } from '@app/components/authors';
  

• At the end of the document, add the Authors component after a divider:

  ---
  
  <Authors path="apps/docs/pages/<path-to-document>/filename.mdx" />
  

• The component then displays a list of the last several GitHub users who edited the document, and users can see how long ago the edits were made in the tooltip:

  

• The title of the document must be H1. Check the basic template. For example: # Algolia API documentation

• Headings must be H2. For example: ## Imports