Contributing

Local preview

npm ci
npm run dev

The production check is:

npm run build

This validates inventory records, type-checks Astro content, and builds the static site for https://docs.team8044.org/.

Add or update a tool

1. Edit src/data/tools.json. Keep the model number exactly as printed on the tool nameplate.
2. Use a lowercase, stable id and a matching guide path under /tools/handheld/guides/.
3. Preserve every spreadsheet or inventory source in sourceRows; combine duplicate physical inventory into one model record.
4. Link manufacturer product pages and manuals instead of copying manuals into the repository.
5. Add or update the guide in src/content/docs/tools/handheld/guides/.
6. Run npm run build before opening a pull request.

Product information rules

• Use the product’s commercial name as the page title and keep the model as secondary metadata.
• Include only useful model-specific specifications from an official product page or manual.
• Link the exact manufacturer page and manual. Add Amazon only when the listing is verified as the same model; never link a substitute or search result.
• Leave unknown fields as “Not recorded” instead of adding explanatory filler.

Publishing

Cloudflare Pages builds and deploys pushes to main using npm run build and the dist output directory. GitHub Actions runs the same validation for pushes and pull requests in .github/workflows/check.yml. Repository administrators can find hosting and custom domain setup in the repository README.

The documentation site is public; contributing through GitHub requires access to the private repository.