Skip to content

docs: add forgejo-axi to community catalog - #123

Open
escidmore wants to merge 1 commit into
kunchenguid:mainfrom
escidmore:docs/add-forgejo-axi
Open

docs: add forgejo-axi to community catalog#123
escidmore wants to merge 1 commit into
kunchenguid:mainfrom
escidmore:docs/add-forgejo-axi

Conversation

@escidmore

Copy link
Copy Markdown

Intent

Add forgejo-axi to the AXI community catalog, following CONTRIBUTING.md's 'Adding your AXI to the catalog' workflow. forgejo-axi (https://github.com/escidmore/forgejo-axi, author escidmore) is an agent-facing, non-interactive CLI for Forgejo covering the pull request lifecycle, issues, and raw API access with TOON output. The change appends one entry to the community list in catalog.yaml and regenerates README.md and docs/index.html via pnpm run docs:gen — the generated regions were not hand-edited, and docs:check and format:check pass locally. The catalog description was written to match the style of neighboring entries (one sentence, ' - ' separator, backtick/markdown support). Docs-only change; no SDK or bench code touched. This is a fork-based contribution: push target is the escidmore/axi fork, PR opens against kunchenguid/axi main.

What Changed

  • Appends a forgejo-axi entry (author escidmore) to the community list in catalog.yaml, describing an agent-facing, non-interactive Forgejo CLI covering the pull request lifecycle, issues, and raw API access with TOON output.
  • Regenerates the generated: regions of README.md and docs/index.html via pnpm run docs:gen; no hand edits to generated content, confirmed by a passing pnpm run docs:check.

Risk Assessment

✅ Low: Docs-only, single-commit catalog addition whose generated regions are internally consistent with the generator's output and fully match the stated intent, with no logic, SDK, or bench code touched.

Testing

Validated the docs-only forgejo-axi catalog addition end-to-end: confirmed the diff touches only catalog.yaml and the two generated docs surfaces, ran the targeted pnpm run docs:check drift gate (passes, so README.md and docs/index.html match docs:gen output), and captured headless-browser screenshots of docs/index.html showing the new entry rendered correctly as the last row of the community catalog table; format:check was skipped per the test-phase ban on running formatters and is unaffected by this diff since it only covers SDK and workflow files.

  • Evidence: Rendered docs/index.html community catalog showing forgejo-axi row (viewport) (local file: /var/folders/zf/93mvgfyd5_d7l2mz6zw_0fbw0000gn/T/no-mistakes-evidence/01KZ3J5GGV94GMKY77R9B247R1/docs-index-community-viewport.png)
  • Evidence: Full community catalog table element with forgejo-axi entry (local file: /var/folders/zf/93mvgfyd5_d7l2mz6zw_0fbw0000gn/T/no-mistakes-evidence/01KZ3J5GGV94GMKY77R9B247R1/docs-index-community-table.png)
Evidence: docs:check drift gate output
$ node scripts/generate-docs.mjs --check
docs:check ok — generated regions match their sources
docs:check exit: 0

Pipeline

Updates from git push no-mistakes

✅ **intent** - passed

✅ No issues found.

✅ **Rebase** - passed

✅ No issues found.

✅ **Review** - passed

✅ No issues found.

✅ **Test** - passed

✅ No issues found.

  • git diff --stat 93c5f33..4422c96 and per-file diffs of catalog.yaml and README.md — confirmed docs-only scope and that the entry is appended to the community list with intent-matching fields and neighbor-matching style
  • corepack pnpm install + corepack pnpm run docs:check — exit 0, "docs:check ok — generated regions match their sources", proving generated regions were not hand-edited
  • Manual render check: headless Chromium (throwaway Playwright install in /tmp) loaded docs/index.html, scrolled to the community table, captured screenshots, and extracted the rendered row text: "forgejo-axi escidmore Forgejo Pull request lifecycle, issues, and raw API access for self-hosted Forgejo - non-interactive, reconciling mutations, with token-efficient TOON output."
  • git status --porcelain — worktree clean after testing, no transient artifacts left in the working tree
✅ **Document** - passed

✅ No issues found.

✅ **Lint** - passed

✅ No issues found.

✅ **Push** - passed

✅ No issues found.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant