···11+# Bombshell Documentation
22+33+This directory contains the documentation for the different tools and features of Bombshell.
44+55+## Contributing
66+77+To contribute to the documentation:
88+99+1. Fork the repository
1010+2. Make your changes
1111+3. Submit a pull request
1212+1313+### Adding New Pages
1414+1515+To add a new page to the documentation:
1616+1717+1. Create a new Markdown file in the appropriate language directory (e.g., `en/`)
1818+2. Add frontmatter with `title` and `description`
1919+3. Update `config.json` to include the new page in the sidebar
2020+2121+Example frontmatter:
2222+2323+```md
2424+---
2525+title: My New Page
2626+description: Description of my new page
2727+---
2828+2929+# My New Page
3030+3131+Content goes here...
3232+```
3333+3434+### Editing Existing Pages
3535+3636+To edit an existing page:
3737+3838+1. Find the page in the appropriate language directory
3939+2. Make your changes
4040+3. Submit a pull request
4141+4242+## Integration with bomb.sh
4343+4444+This documentation is designed to be integrated with the bomb.sh website. The content in this directory will be pulled into the `/docs/clack/` route in the bomb.sh repository.
4545+4646+## Local Development
4747+4848+To preview the documentation locally, you'll need to clone the bomb.sh repository and set up the integration. Follow these steps:
4949+5050+1. Clone the bomb.sh repository
5151+2. Set up the integration to pull in this documentation
5252+3. Run the development server
5353+5454+See the bomb.sh repository for more detailed instructions on local development.
···11+---
22+title: Example Guide
33+description: A guide in my new Starlight docs site.
44+---
55+66+Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
77+Writing a good guide requires thinking about what your users are trying to do.
88+99+## Further reading
1010+1111+- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
+36
src/content/docs/index.mdx
···11+---
22+title: Welcome to Starlight
33+description: Get started building your docs site with Starlight.
44+template: splash
55+hero:
66+ tagline: Congrats on setting up a new Starlight project!
77+ image:
88+ file: ../../assets/houston.webp
99+ actions:
1010+ - text: Example Guide
1111+ link: /guides/example/
1212+ icon: right-arrow
1313+ - text: Read the Starlight docs
1414+ link: https://starlight.astro.build
1515+ icon: external
1616+ variant: minimal
1717+---
1818+1919+import { Card, CardGrid } from '@astrojs/starlight/components';
2020+2121+## Next steps
2222+2323+<CardGrid stagger>
2424+ <Card title="Update content" icon="pencil">
2525+ Edit `src/content/docs/index.mdx` to see this page change.
2626+ </Card>
2727+ <Card title="Add new content" icon="add-document">
2828+ Add Markdown or MDX files to `src/content/docs` to create new pages.
2929+ </Card>
3030+ <Card title="Configure your site" icon="setting">
3131+ Edit your `sidebar` and other config in `astro.config.mjs`.
3232+ </Card>
3333+ <Card title="Read the docs" icon="open-book">
3434+ Learn more in [the Starlight Docs](https://starlight.astro.build/).
3535+ </Card>
3636+</CardGrid>
+11
src/content/docs/reference/example.md
···11+---
22+title: Example Reference
33+description: A reference page in my new Starlight docs site.
44+---
55+66+Reference pages are ideal for outlining how things work in terse and clear terms.
77+Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
88+99+## Further reading
1010+1111+- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework