docs: regenerate stale reference pages and add optional use case metadata - #92
Merged
Merged
Conversation
Deploying schema-library with
|
| Latest commit: |
8276299
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://090f509f.schema-library.pages.dev |
| Branch Preview URL: | https://ic-docs-usecases-and-stale-p.schema-library.pages.dev |
iddocohen
marked this pull request as ready for review
September 7, 2026 18:11
The committed pages still named InfraGenericDevice, InfraIPAddress and InfraPrefix. The schemas renamed those kinds and the generated output was never refreshed, so docs.generate rewrote 15 pages on an untouched tree. This is that refresh, kept separate from any schema change.
objects/extensions/mlag names objects/extensions/dwdm among the files that re-upsert nyc1-rtr01. No such directory exists anywhere in the history.
iddocohen
force-pushed
the
ic/docs-usecases-and-stale-pages
branch
from
September 8, 2026 05:20
b92d55c to
8276299
Compare
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
1 participant
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.
Housekeeping split out of #91 so that PR shows only its own change.
Two independent things:
15 reference pages were stale on
main. The committed pages still nameInfraGenericDevice,InfraIPAddressandInfraPrefixwhere the schemas sayDcimGenericDeviceandIpamIPAddress. Runninginvoke docs.generateon an untouched checkout rewrites all 15, so CI's "Generated documentation is out of date" check fails on any PR that reaches it. This is that regeneration, and nothing else: every hunk is a kind rename or its knock-on.Two optional metadata keys,
use_casesandnot_covered, rendered as a Use cases section on reference pages. Salvaged from an abandoned branch. Additive: no extension defines them here, so regenerating produces no further diff.Also ignores
docs/superpowers/, which holds working documents rather than library content, in git and in markdownlint.Verified:
docs.generateis idempotent after this,pytest12 passed,yamllintandmarkdownlintclean.