Repository navigation
docs(product-model): add a README and point AGENTS.md at the model - #1341
Merged
Merged
Conversation
The README says how to read the model, that the code wins when they disagree, and that a PR does not have to update it; the maintainer checks it for drift in batches. Refs #1302
Review: the domains/ pages have no front matter, and config.yaml and taxonomies.yaml are not Markdown.
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.
Summary
#1332 added the product model under
product-model/without its README, as I asked in #1302. This adds the README and an AGENTS.md pointer to the model.product-model/README.mdsays what the model covers, how to read its folders, and that the code wins when the two disagree. It also says a PR does not have to update the model. I check it for drift, including links to code that moved, and fix it in batches.product-model/next to the glossary and says it can lag the code.In #1302 I said I would add a test that fails when a code link stops resolving. I dropped it, because it would make some refactors update model links, and a PR should not have to touch the model. I'll check links during the drift reviews instead.
The model uses pdd-kit's file format. The repo does not use the pdd-kit CLI or skills; the README mentions its viewer as optional.
Testing
The documentation and image-pin guards that walk tracked files pass with the new README.
Refs #1302