Repository navigation
docs: assemble the generated API references at build time - #16
Merged
Merged
Conversation
pubid#577: the library reference pages are generated from the sources (the gem's YARD output and pubid-ts's TypeDoc output) and fetched at build time from each repo's main — nothing generated is committed here, so the pages cannot drift from the code. The hand-written api.md becomes the overview and links the two generated pages; the fabricated IdentifierRegistry section is gone (no such API). The fetch fails the build if a source disappears.
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
The website half of pubid#577: the library reference pages are now
generated from the sources themselves and assembled at build time.
scripts/fetch-api-reference.mjsfetches each repo's generatedreference (the gem's YARD output, pubid-ts's TypeDoc output) from
maininto the content collection — nothing generated is committedhere, so the pages cannot drift from the code. Wired as
prebuild;a missing source fails the build.
api.mdbecomes the overview (parse/render/serializetour + the relations doctrine) and links the two generated pages. The
fabricated
Pubid::IdentifierRegistrysection is removed — no suchAPI exists.
Sources: pubid#579 (YARD, drift-gated) and pubid-ts#127 (TypeDoc,
drift-gated).