This directory contains the documentation for the different tools and features of Bombshell.
To contribute to the documentation:
- Fork the repository
- Make your changes
- Submit a pull request
To add a new page to the documentation:
- Create a new Markdown file in the appropriate language directory (e.g.,
en/
) - Add frontmatter with
title
anddescription
- Update
config.json
to include the new page in the sidebar
Example frontmatter:
---
title: My New Page
description: Description of my new page
---
# My New Page
Content goes here...
To edit an existing page:
- Find the page in the appropriate language directory
- Make your changes
- Submit a pull request
This documentation is designed to be integrated with the bomb.sh
website. The content in this repository is deployed to the docs.bomb.sh
subdomain and proxied through bomb.sh/docs/
. Because of this, this site is developed and deployed using /docs/
as a path prefix.
Important
When adding internal docs links, be sure to include the /docs/
prefix!
To preview the documentation locally, clone this repository, install the dependencies with pnpm
, and run the local development server. This site is intentionally developed independently of the main bomb.sh
website.