Documentation

The documentation on this site is created and edited by a variety of contributors. If you would like to contribute to the documentation, follow the steps below.

1. Request access to GitHub.

2. Learn about using Markdown basic syntax.

3. Create or edit any .md (or .mdx) files in src/content/docs/ directory. All files within are mapped to a filename based URL structure.

   Eg. the content at src/content/docs/start/contribute.mdx is available at /start/contribute as you can see in the current URL.

   Any documentation nested within directories will be automatically included in the sidebar navigation. For advanced use-cases you can configure sidebar in astro.config.js.

   Tip

   If you are not comfortable using git you can easily edit files directly on GitHub by clicking the ‘Edit page’ link at the bottom of each page.

   Make sure to create a Pull Request when doing this, so all changes can be team reviewed.

   

4. Additional reading for more advanced content.

   Note

   The previous steps are more than enough to make meaningful contributions to the documentation.

   However if you have a technical basis, continue with these resources to create more advanced content.

   • CommonMark Spec
   • What is MDX
   • Astro & Markdown
   • Starlight & Markdown
   • Starlight Components