Repository navigation
The generated API reference moves to REFERENCE.md - #19
Merged
Merged
Conversation
The package README carried the whole generated API table inline, which made the human-written part of the file — what the package is for, how to install it, the quick start — a rounding error against ten thousand lines of generated tables. Corlib's readme was 13165 lines, of which roughly 11000 were generated. Each package now keeps a one-line pointer between the API markers and the generated reference lives beside it in REFERENCE.md. The packaged readme stays readable on nuget.org, and a regeneration no longer rewrites the prose file.
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.
The package readmes carried the whole generated API table inline — Corlib's was 13165 lines, of which roughly 11000 were generated — so the human-written part was a rounding error inside the file.
Each package now keeps a one-line pointer between the API markers, and the generated reference lives beside it in
REFERENCE.md. Matches the split already landed in AnythingToGif, NativeForms and PhotoManager, and unblocks thepackage READMEscheck, which the current RepositoryTemplate action fails until the split exists.