Skip to content

docs: add jira-axi and confluence-axi to community catalog - #112

Open
emilchristensen wants to merge 1 commit into
kunchenguid:mainfrom
emilchristensen:add-jira-confluence-community
Open

docs: add jira-axi and confluence-axi to community catalog#112
emilchristensen wants to merge 1 commit into
kunchenguid:mainfrom
emilchristensen:add-jira-confluence-community

Conversation

@emilchristensen

Copy link
Copy Markdown

Intent

The developer wanted to add two tools, jira-axi and confluence-axi, to the community list in the AXI catalog (kunchenguid/axi upstream), following the repo's CONTRIBUTING.md exactly. They specified precise values for both entries (name, url, author, domain, description) using five fields in a fixed order, matching the existing community entries and preserving the file's ordering convention, with both URLs deep-linking into the emilchristensen/atlassian-axi monorepo package directories (to be verified against origin/main, falling back to the monorepo root if a path was wrong). They required regenerating docs via pnpm run docs:gen rather than hand-editing generated regions, so the PR would contain exactly three files (catalog.yaml, README.md, docs/index.html) without touching guarded release files, and validated with git diff --stat and pnpm run docs:check. Finally, they mandated committing with a specific message and shipping through the no-mistakes gate pointed at the captain's fork (never a hand-opened PR), driving the pipeline until a PR into kunchenguid/axi:main was open with green CI.

What Changed

  • Added two community: entries to catalog.yamljira-axi (domain: Issue tracking) and confluence-axi (domain: Documentation), both authored by emilchristensen and deep-linking into the emilchristensen/atlassian-axi monorepo package directories.
  • Regenerated the marked generated:... regions of README.md and docs/index.html via pnpm run docs:gen to reflect the two new catalog rows; generated regions were not hand-edited and no guarded release files were touched.

Risk Assessment

✅ Low: Docs-only catalog addition where the two hand-edited catalog.yaml entries follow the established convention exactly, the generated README/HTML regions pass docs:check with zero drift, and both deep-link URLs were verified to resolve to real package directories on the target repo's main branch.

Testing

Ran the smallest relevant checks for a catalog-plus-generated-docs change: git diff --stat confirmed the 3-file scope with no guarded release files, pnpm run docs:check passed proving README.md and docs/index.html match catalog.yaml, and re-running pnpm run docs:gen produced no diff (generated, not hand-edited). Verified both deep-link URLs resolve on emilchristensen/atlassian-axi main via authenticated gh api (packages jira-axi/confluence-axi present) plus HTTP 200 on the clickable tree URLs against a 404 control. Captured reviewer-visible visual evidence by rendering docs/index.html in Chrome and screenshotting the community table, which shows both new rows (jira-axi / Issue tracking, confluence-axi / Documentation) with correct links, domains, and descriptions appended after glab-axi. All checks passed; worktree left clean with transient screenshots removed.

  • Evidence: Rendered community table with jira-axi and confluence-axi entries (local file: /var/folders/ch/2x1ggt6945jf7jjng1rmhyrh0000gn/T/no-mistakes-evidence/01KY82C40GGFK48H7FC2D5K951/community-table-new-entries.png)
Evidence: docs:check result
$ pnpm run docs:check
docs:check ok — generated regions match their sources
Evidence: atlassian-axi packages on main (deep-link targets exist)
$ gh api repos/emilchristensen/atlassian-axi/contents/packages?ref=main --jq '.[].name'
confluence-axi
core
jira-axi

HTTP: jira-axi tree URL 200, confluence-axi tree URL 200, bogus path 404

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 d5aa171..25bd175 - confirmed exactly 3 files (catalog.yaml, README.md, docs/index.html), no guarded release files
  • pnpm install --frozen-lockfile - deps installed for docs scripts
  • pnpm run docs:check - passed: 'generated regions match their sources' (README/index.html match catalog.yaml)
  • pnpm run docs:gen then git status --porcelain - idempotent, zero diff vs committed generated files
  • gh api repos/emilchristensen/atlassian-axi/contents/packages?ref=main - confirmed jira-axi and confluence-axi package dirs exist on main
  • curl HTTP status on both tree URLs (200) vs a bogus path (404) - deep-links resolve
  • chrome-devtools-axi opened rendered docs/index.html and screenshotted the community table showing both new entries
✅ **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