docs: add pg-axi to the community catalog - #126
Open
Abdul-Rehman6 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.
What Changed
pg-axientry (authorAbdul-Rehman6, domain PostgreSQL) to thecommunitylist incatalog.yaml.README.mdanddocs/index.htmlwith 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.
/var/folders/3g/gf0z3mxn10963w_9yz8k3jm40000gq/T/no-mistakes-evidence/01KZDGGZ46T0MP11S3GMYZD979/community-catalog-pg-axi.png)/var/folders/3g/gf0z3mxn10963w_9yz8k3jm40000gq/T/no-mistakes-evidence/01KZDGGZ46T0MP11S3GMYZD979/community-catalog.png)Evidence: Generated README rows - both pg-axi entries
Evidence: docs:check - generated regions match catalog.yaml
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 namedpg-axiin the PostgreSQL domain: the pre-existingthatdudealso/pg-axi(catalog.yaml:109) and the newly addedAbdul-Rehman6/pg-axi(catalog.yaml:154). The docs generator performs no duplicate-name validation, sopnpm run docs:checkpasses and the rendered site + README show two identically-labelledpg-axirows, 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 driftpnpm run docs:test(node --test scripts/generate-docs.test.mjs) - generator escaping/link/table semantics; 4/4 passedManual render: headless Chrome screenshot ofdocs/index.htmlcommunity catalog table, confirming the new pg-axi row renders with correct author, domain, description and linkcurl -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.