Skip to content

README.md

Latest commit

 

History

History
52 lines (37 loc) · 2.36 KB

README.md

File metadata and controls

52 lines (37 loc) · 2.36 KB
Raw

Hive Commons Documentation

Hive Commons Logo

Documentation for the Hive Commons projects

Official documentation site for Hive Commons, served at docs.hivecommons.dev. It covers:

  • Hive — autonomous AI agent fleets for your repositories
  • hotshot — screenshots straight into your AI coding terminal
  • pluk — pub-sub event streaming for AI agent tmux sessions
  • rationguard — detect and rebut rationalization patterns in AI agent output
  • promptargs — template expansion for AI prompts
  • dibs — claim ideas so contributors get credit when agents implement them
  • Spektacular — spec-driven development for AI coding agents (canonical site: spektacular.dev)

How content is sourced

Hive, hotshot, pluk, rationguard, promptargs, dibs, and Spektacular docs are single-sourced from their repositories and pulled at build time:

  • scripts/sync-hive-docs.ts pulls Hive docs from hivecommons/hive (src/docs/, branch v5; override with HIVE_DOCS_OWNER / HIVE_DOCS_REPO / HIVE_DOCS_REF).
  • scripts/sync-sibling-docs.ts pulls the hotshot, pluk, rationguard, promptargs, dibs, and Spektacular docs from their repos. Spektacular also pulls its tutorials from hivecommons/spektacular-website (MDX, converted to Markdown by scripts/mdx-to-markdown.ts; override the ref with SPEKTACULAR_WEBSITE_DOCS_REF).

Edit the canonical source in the project repository — not the synced copies under docs/content/. If a sync source is unreachable at build time, the committed copies are used as a fallback.

Development

npm install
npm run dev        # http://localhost:3000

The site is Next.js + Nextra, deployed on Netlify (site hivecommons-docs). Navigation is defined in src/app/docs/page-map.ts; project registry in src/config/versions.ts.

Contributing

PRs welcome. Sign your commits (DCO): git commit -s.

License

Apache 2.0