Argus
Contributing

Documentation

Author Argus documentation once in Fumadocs MDX and verify its human, Markdown, LLM, installer, and Agent Skill distribution surfaces.

The human handbook lives in apps/web/content/docs as version-controlled MDX. Every page needs frontmatter with a non-empty title and description. Navigation comes from the nearest meta.json; keep operator pages at the docs root and contributor pages under contributing/. Do not add aliases or copy an operator procedure into contributor or agent documentation.

Source of truth

Write operational instructions in the existing Fumadocs pages. The web app turns that source into the rendered /docs handbook, /llms.txt, /llms-full.txt, and /docs/<path>.md. Update the actual CLI, schema, route, or release implementation first, then document its current behavior with secret-free examples.

The portable setup skill is a separate source tree at skills/argus-setup. Keep detailed agent request routing there, validate it with the skill scripts, and link to it from Agents rather than duplicating its rules.

Verify documentation changes

pnpm --filter @argus/web generate
pnpm vitest run apps/web/test/content.test.ts apps/web/test/routes.test.ts apps/web/test/distribution.test.ts
pnpm --filter @argus/web build
pnpm --filter @argus/web check:links

The content tests enforce route inventory, navigation separation, required frontmatter, and local Markdown links. Route and distribution tests prove the LLM, Markdown, installer, and skill endpoints. Independently, the web CI job runs the broader web suite, Lighthouse CI, and a tracked-secret-file check. Run those same checks as a contributor requirement; the repository does not configure them as a gate or ordering dependency for the Git-connected Vercel deployment.

On this page