Conversation
Co-authored-by: apehex <17317183+apehex@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Move usage information to docs/package directory
Move package usage docs to Mar 16, 2026
docs/package and slim .github/README.md to quickstart
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.
The current package usage documentation was concentrated in
.github/README.md, making it hard to maintain and navigate by module. This PR relocates and expands usage docs underdocs/package/, then simplifies the README to a quickstart + references.Package docs split by module
docs/package/layers/{index,shaping,embedding,transformer}.mddocs/package/metrics/{index,group_accuracy}.mdDivide,Merge)TokunEmbedding,RotaryPositionalEmbedding)FeedForwardNetwork,CachedMultiHeadAttention)CategoricalGroupAccuracy,BinaryGroupAccuracy,RawGroupAccuracy)src/mlable/*APIs and expected usage patterns shown in tests.README cleanup
.github/README.mdwith:docs/package/.Docs navigation updates
docs/package/index.mdwith direct links to newly added guides.docs/index.mdto referencedocs/package/structure.docs/todo.mdto reflect that metrics API examples now exist in package docs.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.