General structure of the site, where to find the files you're likely to want to edit. Reminder to add the required frontmatter and what all the bits mean (and explain what frontmatter is!)
You can edit the markdown directly in github for small changes (eg fix a spelling mistake)
internal people, how to find and use the Content Management System (CMS) (/keystatic, only available if you have write access to this repo). Use this if you've already written most of your content or are making a small change, as saving files in the CMS uses up credit on my personal infrastructure at the moment
If you're doing a lot of writing (or aren't an internal person) please do this locally on your computer then make a pull request
instructions for how to clone the repository, install the dependencies, run the code, edit the markdown, preview the markdown
If you did something wrong, the build might fail, explain how to check for and resolve build failures
link to the framework (starlight) docs, in case there's useful things there. Particularly point out the expressive code stuff, which is nice for writing code samples. Link also to a basic markdown guide
Some of this information is currently in the README, but it probably isn't very clear and assumes too much knowledge.
There should probably also be a separate page about how to generate the docs for a new plugin/version, when that work is done. Hopefully this is just run a script, but I need to write it down in any case.
I think this should go as a page in the docs site, under internal
I need to cover
General structure of the site, where to find the files you're likely to want to edit. Reminder to add the required frontmatter and what all the bits mean (and explain what frontmatter is!)
You can edit the markdown directly in github for small changes (eg fix a spelling mistake)
internal people, how to find and use the Content Management System (CMS) (
/keystatic, only available if you have write access to this repo). Use this if you've already written most of your content or are making a small change, as saving files in the CMS uses up credit on my personal infrastructure at the momentIf you're doing a lot of writing (or aren't an internal person) please do this locally on your computer then make a pull request
If you did something wrong, the build might fail, explain how to check for and resolve build failures
link to the framework (starlight) docs, in case there's useful things there. Particularly point out the expressive code stuff, which is nice for writing code samples. Link also to a basic markdown guide
Some of this information is currently in the README, but it probably isn't very clear and assumes too much knowledge.
There should probably also be a separate page about how to generate the docs for a new plugin/version, when that work is done. Hopefully this is just run a script, but I need to write it down in any case.
I think this should go as a page in the docs site, under
internal