No description
- Go 91.3%
- Shell 5.2%
- Makefile 3.5%
Kai Siren
db331fcbff
Some checks failed
ci / test (push) Has been cancelled
ci / lint (push) Has been cancelled
ci / govulncheck (push) Has been cancelled
ci / docs (push) Has been cancelled
codeql / analyze (go) (push) Has been cancelled
pages / build (push) Has been cancelled
pages / deploy (push) Has been cancelled
Bump the agentic-os pre-commit suite to v0.2.8 and walk every flagged file. Package godoc and multi-line block comments collapsed to the 2-line cap; durable detail moved into docs/webdocs-package.md and docs/layout-package.md with one-line pointers at the source. Side-effects in the same commit per AGENTS.md sweep rule: - .claude/lockdown-deny.sh: trimmed the auto-generated header to fit the 2-line cap (regenerate via `coily lockdown --apply --replace` pulls in the new shape upstream). - .claude/settings.json: end-of-file-fixer trailing newline. - scripts/check-godoc-current.sh: normalize trailing newlines so end-of-file-fixer and the godoc snapshot stop fighting. - layout/example_test.go: collapse multi-line `// Output:` block to a single-line check so the Example function stays valid. Skipped via SKIP env: catalog-doc-size, catalog-trifecta, documentation-layout. Those expose pre-existing violations (duplicate CODE_OF_CONDUCT.md over 4000 chars, examples/*/README.md outside the allow-list, AGENTS.md missing standard H2 sections) that are out of scope for the code-comments cleanup and need separate follow-ups. |
||
|---|---|---|
| .agent-guard | ||
| .claude | ||
| .github | ||
| deploy | ||
| docs | ||
| examples | ||
| layout | ||
| scripts | ||
| .gitignore | ||
| .golangci.yaml | ||
| .pre-commit-config.yaml | ||
| AGENTS.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| example_test.go | ||
| go.mod | ||
| go.sum | ||
| godoc-current.txt | ||
| LICENSE | ||
| Makefile | ||
| mkdocs-requirements.txt | ||
| mkdocs.yml | ||
| README.md | ||
| SECURITY.md | ||
| staticcheck.conf | ||
| webdocs.go | ||
| webdocs_test.go | ||
cli-web-docs
cli-web-docs is a static HTML documentation generator for urfave/cli v3 command trees, featuring:
- canonical Markdown from urfave/cli-docs, rendered to HTML by goldmark
- single-page or per-command output via
Options.PerPage - shared layout subpackage (also consumed by cli-web-ops) so docs + ops pages read as one site
- dark-mode-aware default stylesheet, fully overridable via
Options.CSS - pure Go, no JavaScript in the generated output
- pairs with any static host (GitHub Pages, S3, Caddy via
deploy/Caddyfile.example)
Documentation
See docs/FEATURES.md for a feature inventory and examples/ for four runnable demos (render, multi-page, custom-theme, deep-tree). Local dev verbs live in .agent-guard/agent-guard.yaml; agent-guard lint validates that against the Makefile.
Support
If you found a bug or have a feature request, create a new issue. Participation in this community is governed by the Code of Conduct. Security disclosures go through SECURITY.md.
Sibling repos in the cli-* family: cli-guard, cli-mcp, cli-web-ops.
License
See LICENSE.
See also
- AGENTS.md - agent-facing operating rules.
- docs/FEATURES.md - inventory of what ships today.
- .agent-guard/agent-guard.yaml - allowlisted commands.
Cross-reference convention from coilysiren/agentic-os#59.