docs: the agents page is part of the public API, and one shared copy-page script - #63
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
This is the tail of a rollout:
docs/agents.mdand the Copy page control started here, and are now going into every library in the organisation. Two things follow from that.The rule was never written down. The page is the one people hand to an assistant instead of the site, so a stale one is worse than none — it teaches a model an API that no longer exists.
CONTRIBUTING.mdnow says it is part of the public API and changes in the same pull request the API does, and the pull request checklist names it on the documentation line. The new section also records how the Markdown twins get written and why the API reference declines them, which was folklore until now.The script had this library's name baked in.
copy-page.jsbuilt its prompt around the literal stringpg-partsmith, which meant every other repository would carry a near-copy differing in one word. The name now comes fromconfig.site_namethrough adata-copy-siteattribute, so the four shared files — the script, the stylesheet,overrides/main.htmlandscripts/emit_markdown.py— are byte-identical everywhere and can be updated in one sweep.No behaviour change: the control renders and reads the same, and the prompt it builds is the same sentence it was.
Verified with a full build:
zensical build --cleanreports no issues,emit_markdown.pywrites 45 pages with 1 declined, and the built HTML carriesdata-copy-site="pg-partsmith".uv.lockuntouched.