Documentation
This section covers how to contribute to the Neurodesk documentation. The site is built with
Astro and the Starlight theme, and
pages are written in Markdown or MDX under src/content/docs/.
Where to start
Section titled “Where to start”The pages below are ordered the way you will need them:
-
Contribute Content — fork the repository, create a branch, write your page, and open a pull request. Start here.
-
Local Development — install Node.js and pnpm and run the site on your machine so you can preview changes as you write.
-
Markdown Reference — the syntax and components available when writing a page. Keep this open while you work.
Indexing with Algolia covers site search configuration. That is a maintainer task and is not needed to contribute content.
Just fixing a typo?
Section titled “Just fixing a typo?”You do not need any of this. Open the page on GitHub, click the pencil icon, make your change, and propose it as a pull request from the browser.