bomb.sh / docs
[READ-ONLY] Mirror of https://github.com/bombshell-dev/docs. bomb.sh/docs
0
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

docs: update readme

Nate Moore (Mar 31, 2025, 9:20 PM -0500) f371f79f cc970d88

+5 -8
+5 -8
README.md
··· 41 41 42 42 ## Integration with bomb.sh 43 43 44 - 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. 44 + 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. 45 + 46 + > [!IMPORTANT] 47 + > When adding internal docs links, be sure to include the `/docs/` prefix! 45 48 46 49 ## Local Development 47 50 48 - To preview the documentation locally, you'll need to clone the bomb.sh repository and set up the integration. Follow these steps: 49 - 50 - 1. Clone the bomb.sh repository 51 - 2. Set up the integration to pull in this documentation 52 - 3. Run the development server 53 - 54 - See the bomb.sh repository for more detailed instructions on local development. 51 + 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.