Repository navigation
Add product registry definitions for the Docusaurus build - #7233
Merged
Merged
Conversation
One .registry.yaml per top-level content directory, and one in each directory holding a nested product. Each says what the product in its directory is: kind, display names, aliases, icon, versions. Keeping them next to the content means a change to a product's content and to its definition land in the same PR, and a lint check can hold them to each other. edb-postgres-ai's definition is under product_docs/docs, which holds its version directories; its two nested products are in advocacy_docs. The Gatsby build ignores them: sourced, each would become a File node, and onCreateNode copies every .yaml file into public/. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
josh-heyer
requested review from
a team,
anjali-edb,
gvasquezvargas,
irmabenitezzapata-creator,
jpe442,
mpfuster and
nidhibhammar
as code owners
October 27, 2026 02:14
The playground's expression-replacement page names a pseudo-product, "Expression Replacement", which the Gatsby build defines in src/constants/products.js. In the Docusaurus build's definitions it was an alias on the playground section, which has no short name, so the page's "Scope of" heading rendered an error there. The page moves to expression-replacement/index.mdx (same URL), beside its own .registry.yaml carrying the names from products.js, and the alias moves there from the playground's definition. The Gatsby build is unchanged: the page's product: and version: frontmatter still map to products.js. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully deployed
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?
Adds a
.registry.yamlfile to each top-level content directory, and one in each directory that holds a nested product, such asadvocacy_docs/pg_extensions/pg_squeeze/. Each file says what the product in its directory is: whether it's a product or a section, its display names, its aliases, its icon and which subdirectories are versions. For example,product_docs/docs/pgd/.registry.yaml:These definitions are for the Docusaurus build. The Gatsby build doesn't read them, and
gatsby-config.jsnow tells its filesystem sources to ignore them. Without that, Gatsby would publish each file to the site, because it copies every.yamlfile it sources intopublic/.edb-postgres-aiis split across both content roots. Its one definition is inproduct_docs/docs/edb-postgres-ai/, where its version directories are.The expression-replacement demo
The playground's expression-replacement page moves to
expression-replacement/index.mdx(same URL), with its own.registry.yamlholding the namessrc/constants/products.jsgives "Expression Replacement". In the Docusaurus build that name was an alias on the playground section, which has no short name, so the page's "Scope of" heading rendered an error. The Gatsby build is unchanged: the page'sproduct:andversion:frontmatter still map toproducts.js.For writers, once the Docusaurus build reads these files: adding a new top-level product directory, or a new version of
edb-postgres-ai, needs a matching change to its.registry.yamlin the same PR. Most versioned products useversions: all, so adding a version to them needs no change.🤖 Generated with Claude Code
Tip
Draft deployment: https://deploy-preview-7233--edb-docs-staging.netlify.app/docs/