If this is your first encounter with a git-based workflow, we recommend that you study up on what git is and how git (and GitHub) works. One such tutorial is available here.

Before attempting to compile and show the website locally, please ensure that:

• NodeJS is installed on your system
• pnpm is available and in your path
  • with NodeJS installed, you can run the following from your ${HOME} directory:

    npm install pnpm@latest-10
    

  • Make sure you add ${HOME}/node_modules/.bin to your shell ${PATH}
• With the above prerequisites satisfied, clone the present repo and cd into the root of it.
• Then run:

  pnpm install
  

After the above import and install operations have completed successfully on your system, run:

pnpm run dev

... and follow the instructions shown.

At this point, any time you edit a page, the changes should show up live in your browser..

When you are happy with your edits, commit your changes in your local git repository and create a Pull Request from said local changes.

We recommend that you consult the Solus documentation style guide when it comes to how to address your target audience.

When describing your changes, use imperative mood, present tense and an active voice.

Example:

packaging: Add goober subsection on frobnicating

- Add up front context that the user needs to know
- Ensure that the structure flows naturally from start to finish
- Simplify the fiddlybob section language to shorter, international english sentences
- Run spellcheck on the changes to ensure they are written in US English.

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

All commands are run from the root of the project, from a terminal:

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.