Writing Docs
Astro Starlight
Section titled “Astro Starlight”Astro Starlight is a static site generator that allows you to create documentation sites using Markdown and React components. It is designed to be fast, flexible, and easy to use.
MDX is a format that allows you to write JSX in Markdown documents. This means you can use React components in your Markdown files, which can be very powerful for creating interactive documentation.
How to write docs?
Section titled “How to write docs?”You can use the official Astro Starlight documentation to learn how to write documentation using MDX. The documentation covers everything from basic syntax to advanced features like custom components and theming.
Read the official docs
Branching
Section titled “Branching”When there are major changes it can be helpfull to create a new branch for the documentation. This way you can work on the documentation without affecting the main branch. Once the changes are complete, you can merge the branch back into the main branch. Please check if your local environment is fully working before pushing the changes to the main branch. Everything push to the main branch will be deployed automatically.