docs: add module catalog, API reference, and architecture overview - #119
Merged
Conversation
Add a docs/ directory with a verified module catalog, public API reference, architecture overview, and newcomer README. Also refine the model-persistence and live-rebalance tickets with precise line numbers and the Portfolio seeding detail.
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.
Adds a
docs/directory documenting the package:Also refines the model-persistence and live-rebalance tickets with precise line numbers and the Portfolio seeding detail.
No code changes — documentation and ticket refinement only.