@x12i/activix-docs
v1.0.0
Published
Activix monorepo docs knowledge SDK for x12i-docify — install as a devDependency only. Catalog, guides, and coding-agent instructions for @x12i/activix-contracts, @x12i/activix, and @x12i/optimixer.
Downloads
87
Maintainers
Readme
@x12i/activix-docs
Activix monorepo docs knowledge SDK for the x12i-docify platform. Install as a devDependency only — do not add to production service dependencies.
npm i -D @x12i/activix-docsimport { activixDocs } from "@x12i/activix-docs";
activixDocs.getUseCaseMarkdown("track-an-activity");
activixDocs.getBookMarkdown("02-activix", "developers");
activixDocs.listUseCases();CLI:
npx activix-docs list-use-cases
npx activix-docs use-case predict-max-tokens > pack.md
npx activix-docs book 03-optimixer developers > book.mdHumans (local docs site)
From the monorepo:
npm run docs # build if needed, serve, open browser (port 4173)
npm run docs:rebuild # force rebuild + serve
npm run docs:verify # verify assets + open-Markdown package contract
npm run docs:publish # Cloudflare Pages → docs.activix.x12i.com
npm run publish:docs # npm publish this knowledge packageSite: https://docs.activix.x12i.com
What this package covers
| Book | Package / topic |
|------|-----------------|
| Monorepo overview | Activitix workspace map |
| Activix contracts | @x12i/activix-contracts |
| Activix | @x12i/activix |
| Optimixer | @x12i/optimixer |
| Publishing | npm + Cloudflare docs |
Open Markdown lives under files/ (INDEX.md, SEARCH.json, packs). Humans deploy dist/web (not shipped in the npm tarball).
