Document portfolio GUI usage#29
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the local-only Portfolio GUI (tl portfolio gui) to address Issue #22, with a tab-by-tab walkthrough and privacy/safety guidance consistent with the project’s “local decision support” design.
Changes:
- Link Portfolio GUI walkthrough docs from
README.mdanddocs/local_portfolio.md. - Add
docs/portfolio_gui.mdwith launch instructions, tab descriptions (Daily/Positions/Open orders/Edit local CSVs), risk modes, snapshots, and outcome tracking. - Reinforce local-only/privacy constraints and recommend running the repo audit script before publishing examples.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a link to the new Portfolio GUI walkthrough documentation alongside existing local portfolio docs. |
| docs/portfolio_gui.md | New detailed walkthrough for the local Portfolio GUI, emphasizing local-only behavior and safe synthetic examples. |
| docs/local_portfolio.md | Cross-links to the new GUI walkthrough for deeper UI guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+66
to
+80
| The Daily tab is the main morning review screen. It shows: | ||
|
|
||
| - The current action. | ||
| - The decision sentence. | ||
| - Current traded-symbol position and allocation. | ||
| - Pending buy/sell notional. | ||
| - Max recommended exposure and buy capacity. | ||
| - Portfolio action. | ||
| - Advice and interpretation. | ||
| - Suggested order ideas. | ||
| - Portfolio summary. | ||
| - Dates and update metadata. | ||
| - Snapshot controls. | ||
| - Outcome tracking controls. | ||
|
|
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.
Adds safe local-only portfolio GUI usage documentation with tab walkthroughs, risk modes, snapshots, and outcome tracking. Closes #22.