feat: Add About/Help tab with markdown-rendered informational page#5
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Agent-Logs-Url: https://github.com/jrkasprzyk/ArborView/sessions/57a901b2-4b16-4ed5-a963-290aae19df71 Co-authored-by: jrkasprzyk <4161712+jrkasprzyk@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add instructional and informational page on the app
feat: Add About/Help tab with markdown-rendered informational page
May 5, 2026
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
zaca1902
reviewed
May 5, 2026
| 4. **Pan and zoom** the tree canvas with your mouse — click-and-drag to pan, scroll to zoom. | ||
| 5. **Read the decision path** in the "Decision path" panel on the right. It shows the sequence of split rules from the root down to the selected node, ending with the node's prediction. | ||
| 6. **Review node details** in the "Node detail" panel. It shows statistics like sample count, impurity, complexity, and for classification trees, the class probability bars. | ||
| 7. **Check variable importance** at the bottom of the sidebar — the chart shows which predictors contributed most to splits in the tree, normalised so the most important variable is always the full bar width. |
Collaborator
There was a problem hiding this comment.
This will need to be updated/added to if we are including the relative importance for the predictors.
Owner
There was a problem hiding this comment.
Good to know. For our purposes right now, we just need to know if the documentation is accurate right now; is it?
Collaborator
There was a problem hiding this comment.
Yes, the current information looks accurate to me!
zaca1902
reviewed
May 5, 2026
| - **Impurity metric:** Mean Squared Error (MSE = deviance / n). Lower MSE = more homogeneous node. | ||
| - **Color coding:** In regression trees, node color is scaled by the predicted mean response value. | ||
|
|
||
| ## Node Statistics Reference |
Collaborator
There was a problem hiding this comment.
Add: "Tree Statistics Reference" for the accuracy and sensitivity
Owner
There was a problem hiding this comment.
If the features aren't in here yet, we shouldn't have them in the about; we can update it after the features are added. Sound good?
Collaborator
There was a problem hiding this comment.
Excellent point! Yes, it sounds good to me to update the information following the feature additions.
zaca1902
reviewed
May 5, 2026
|
|
||
| Predictor variable descriptions depend on the specific model and dataset loaded. Refer to the dataset documentation provided alongside each model for definitions of individual predictor names. | ||
|
|
||
| The **Variable importance** panel ranks predictors by their total contribution to impurity reduction across all splits in the tree. A predictor can appear as important even if it is not used at the root split — it may be used repeatedly at deeper levels. |
Collaborator
There was a problem hiding this comment.
Add: a description of the relative importance
zaca1902
reviewed
May 5, 2026
zaca1902
left a comment
zaca1902
left a comment
Collaborator
There was a problem hiding this comment.
Looks great overall! I just added a few comments to reflect some of the recent and/or upcoming revisions.
Owner
If we haven't added the features yet, we shouldn't put them in the about; we should only update that after the features have been added. Check my responses and let me know when you're OK with that, thanks! |
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 app had no in-app documentation — no explanation of the tool, how to use it, or what CART classification vs. regression means. This adds an About tab that renders a user-editable Markdown file, addressing all four points from the issue.
Changes
New tab UI
Visualizer | Abouttab navigation to the header with full ARIA roles (tablist,tab,tabpanel)#panel-visualizer; new#panel-aboutpanel toggled on tab switch viaactivateTab()Markdown rendering
loadAbout()fetches/about.mdat startup, parses withmarked, sanitizes withDOMPurify, and injects into the article element/about.md) avoids breakage under subdirectory deploymentsDefault content (
public/about.md)Covers the four areas from the issue:
Footer note instructs users to replace the file with model-specific content (custom response variable description, predictor definitions, data source, etc.).
Styling
styles.css, matching the existing design tokens (--accent,--muted,--mono, etc.)