Reqstool Documentation

Central documentation site for the reqstool ecosystem. Built with Antora and published to GitHub Pages.

Live site: https://reqstool.github.io

Included components

Component	Source repo
reqstool CLI	reqstool-client
Java Annotations	reqstool-java-annotations
Maven Plugin	reqstool-java-maven-plugin
Gradle Plugin	reqstool-java-gradle-plugin
Python Decorators	reqstool-python-decorators
Hatch Plugin	reqstool-python-hatch-plugin
Poetry Plugin	reqstool-python-poetry-plugin
VS Code Extension	reqstool-vscode-extension
TypeScript Tags	reqstool-typescript-tags
AI Integration	reqstool-ai
Demo Project	reqstool-demo

Build locally

Prerequisites: Node.js 18+

# Install dependencies
npm install

# Build using local filesystem paths (requires all repos cloned as siblings)
npm run build:local

# Preview the built site
npm run preview

Adding a new component

1. Add Antora docs structure to your repo (docs/antora.yml, docs/modules/ROOT/pages/, etc.)
2. Add the repo as a content source in docs/antora-playbook.yml and docs/local-antora-playbook.yml
3. Add navigation links in the landing page (docs/modules/ROOT/pages/components.adoc)

Contributing

See the organization-wide CONTRIBUTING.md.

License

MIT License.