Skip to content

docs: add pg-axi to the community catalog - #126

Open
Abdul-Rehman6 wants to merge 1 commit into
kunchenguid:mainfrom
Abdul-Rehman6:add-pg-axi-catalog
Open

docs: add pg-axi to the community catalog#126
Abdul-Rehman6 wants to merge 1 commit into
kunchenguid:mainfrom
Abdul-Rehman6:add-pg-axi-catalog

Conversation

@Abdul-Rehman6

Copy link
Copy Markdown

What Changed

  • Added a pg-axi entry (author Abdul-Rehman6, domain PostgreSQL) to the community list in catalog.yaml.
  • Regenerated the community catalog tables in README.md and docs/index.html with the matching row.

Risk Assessment

✅ Low: Docs-only addition of one community catalog entry; the generated README and HTML regions are consistent with what scripts/generate-docs.mjs plus prettier would emit, and the linked repository resolves.

Testing

Ran the docs generator's own check and unit tests to prove the committed README and site rows are exactly what catalog.yaml generates, then rendered docs/index.html in headless Chrome and captured a screenshot of the Community table showing the new pg-axi row as an end user would see it, and confirmed the linked repo URL returns 200. Everything the change intended works, but the visual check revealed the catalog already contains a different pg-axi entry (thatdudealso, also PostgreSQL), so two identically-named rows now appear and the generator has no duplicate-name guard - that needs an author decision.

  • Evidence: Rendered community catalog table showing the new pg-axi row (headless Chrome, docs/index.html) (local file: /var/folders/3g/gf0z3mxn10963w_9yz8k3jm40000gq/T/no-mistakes-evidence/01KZDGGZ46T0MP11S3GMYZD979/community-catalog-pg-axi.png)
  • Evidence: Community catalog table top (context for the rendered section) (local file: /var/folders/3g/gf0z3mxn10963w_9yz8k3jm40000gq/T/no-mistakes-evidence/01KZDGGZ46T0MP11S3GMYZD979/community-catalog.png)
Evidence: Generated README rows - both pg-axi entries
$ grep -n "pg-axi" README.md
138:| [`pg-axi`](https://github.com/thatdudealso/pg-axi) | thatdudealso | PostgreSQL | Discover, create, inspect, query, back up, restore, and maintain PostgreSQL databases through safe token-efficient CLI workflows. |
147:| [`pg-axi`](https://github.com/Abdul-Rehman6/pg-axi) | Abdul-Rehman6 | PostgreSQL | Inspect schemas, run capped queries, and read query plans over the shell - token-efficient TOON output, partition-aware row counts. |
Evidence: docs:check - generated regions match catalog.yaml
$ pnpm run docs:check
docs:check ok — generated regions match their sources
- Outcome: ⏭️ skipped across 1 run (2m39s)

Pipeline

Updates from git push no-mistakes

⏭️ **intent** - skipped

✅ No issues found.

✅ **Rebase** - passed

✅ No issues found.

✅ **Review** - passed

✅ No issues found.

⏭️ **Test** - skipped
  • ⚠️ catalog.yaml:154 - The community catalog now lists two distinct entries both named pg-axi in the PostgreSQL domain: the pre-existing thatdudealso/pg-axi (catalog.yaml:109) and the newly added Abdul-Rehman6/pg-axi (catalog.yaml:154). The docs generator performs no duplicate-name validation, so pnpm run docs:check passes and the rendered site + README show two identically-labelled pg-axi rows, which is ambiguous for readers choosing a tool. Needs a product decision: rename the new entry, disambiguate the label, or accept the collision.
  • pnpm install --ignore-scripts (workspace deps for the docs generator)
  • pnpm run docs:check - regenerates catalog regions from catalog.yaml and asserts committed README.md / docs/index.html match; passed with no drift
  • pnpm run docs:test (node --test scripts/generate-docs.test.mjs) - generator escaping/link/table semantics; 4/4 passed
  • Manual render: headless Chrome screenshot of docs/index.html community catalog table, confirming the new pg-axi row renders with correct author, domain, description and link
  • curl -s -o /dev/null -w "%{http_code}" https://github.com/Abdul-Rehman6/pg-axi - catalog URL resolves (200)
  • grep -n "pg-axi" catalog.yaml README.md docs/index.html - surfaced the duplicate-name collision with the existing thatdudealso/pg-axi entry
✅ **Document** - passed

✅ No issues found.

✅ **Lint** - passed

✅ No issues found.

✅ **Push** - passed

✅ No issues found.

@kunchenguid

Copy link
Copy Markdown
Owner

Speaking as Kun's firstmate: independent source review of the proposed catalog add.

Pin inspected: https://github.com/Abdul-Rehman6/pg-axi at 194576c83d2bbfde6568263a5562f30d32043a31 (current main HEAD; catalog.yaml has no pin field, matching existing schema). I did not execute the package.

Source actually read: README.md, package.json, src/index.ts, src/commands/query.ts.

Observations from that source, not the PR body: this is a real PostgreSQL AXI (custom TOON renderer, not axi-sdk-js). No-args home lists tables with row/column counts. Commands: table, query, search, indexes, explain. Unknown flags fail loud; never reads stdin / never prompts for credentials. Empty query results print "0 rows matched". Optional --json is an escape hatch, never the default. Metadata matches the package (pg-axi, PostgreSQL, Abdul-Rehman6). Not official, empty, malware, or a squat of this author's identity.

I am not admitting it yet for two independent reasons:

  1. Catalog identity: community catalog already lists pg-axi as https://github.com/thatdudealso/pg-axi (thatdudealso). This PR would add a second row with the same catalog name. The docs generator does not guard duplicates; axi.md would show two identical labels pointing at different tools. Please pick a distinct catalog name (and matching name/url if you rename the package), or otherwise disambiguate the row, then update catalog.yaml + docs:gen.

  2. The PR is CONFLICTING against current main. Even after a unique name, rebase onto current main before I can merge.

VISION.md per-rule verdict:

  • AXI principles: aligns as a tool (TOON, fail-loud flags, content-first home, structured errors, no prompts). Not a principles change to axi itself.
  • Catalog: cannot tell / not admitted — source is a real AXI at the pin, but the proposed catalog name collides with an existing community entry. Official catalog untouched.
  • SDKs: aligns. No SDK change in this PR; this tool does not use axi-sdk-js, which is allowed.

Not merging. Not a Firstmate flag (identity collision is a contributor fix, not a default-behavior call).

@kunchenguid kunchenguid left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Speaking as Kun's firstmate: source is a real AXI, but catalog name pg-axi collides with the existing thatdudealso/pg-axi entry. Please pick a distinct catalog name and rebase. Not merging.

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.

3 participants