docs: add supabase-axi to the community catalog - #130
Open
laizhenyoong wants to merge 1 commit into
Open
Conversation
4 tasks
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Intent
The developer wanted to contribute their existing supabase-axi CLI tool to the AXI project's community catalog, following the repo's CONTRIBUTING guide, on a short branch named add-supabase-axi. They asked for a short, clean catalog entry and iterated repeatedly on the description wording, first rejecting a version that appended a differentiator clause about reads being read-only inside Postgres and writes requiring --write, then asking that it be rewritten to match the style of the official entries like gh-axi and chrome-devtools-axi (a noun/verb list followed by a "Wraps ..." sentence), settling on "Inspect schemas, run SQL, and audit RLS, indexes, and logs across Supabase projects. Wraps the Supabase Management API." They wanted the generated README.md and docs/index.html regenerated via docs:gen, and explicitly asked that the commit carry no co-author trailer. Because CONTRIBUTING requires it, they also agreed to install the no-mistakes gate and gh, fork kunchenguid/axi while leaving origin pointed at the parent repo, and push the change through the no-mistakes pipeline rather than directly to origin.
What Changed
supabase-axientry (authorlaizhenyoong, domain Supabase) to thecommunitylist incatalog.yaml.README.mdanddocs/index.htmlso both render the new row.Risk Assessment
✅ Low: Docs-only catalog addition whose generated README/HTML regions are consistent with the generator's formatting, links to a verified public repo, and touches no source, workflow, or release-managed files.
Testing
I validated the catalog contribution end-to-end as a reader would see it: ran the repo's docs generator in check mode (passes, proving the README and docs/index.html regions were regenerated from catalog.yaml rather than hand-edited), ran the generator's own unit tests, then rendered docs/index.html in headless Chrome and captured screenshots showing supabase-axi as the final Community row with author laizhenyoong, domain Supabase, the agreed description, and a live repo link (URL returns HTTP 200). One setup issue I worked around: pnpm fails under this machine's default Node 23.3.0, so I installed and ran under Node 24; the worktree was left clean afterward. Everything passed and no findings.
/var/folders/h1/z894nqbd6vlfzgl9tkkn092w0000gn/T/no-mistakes-evidence/01KZKBMAN6V3T7Q53HT78XZDJE/docs-community-catalog.png)/var/folders/h1/z894nqbd6vlfzgl9tkkn092w0000gn/T/no-mistakes-evidence/01KZKBMAN6V3T7Q53HT78XZDJE/supabase-axi-catalog-row.png)Evidence: docs:check output
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.
node scripts/generate-docs.mjs --check(repo'sdocs:check) — generated README/docs regions match catalog.yamlnode --test scripts/generate-docs.test.mjs— 4/4 generator escaping and link-safety tests passRendereddocs/index.htmlheadless in Chrome and screenshotted the Community catalog table showing the new supabase-axi rowcurl -s -o /dev/null -w '%{http_code}' https://github.com/laizhenyoong/supabase-axi→ 200pnpm installunder Node 24 (default Node 23.3.0 in this env cannot run pnpm 11: missingnode:sqlite)✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.