Docs: brand public README and correct architecture docs - #71
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the public-facing documentation to better reflect the current VisualHFT branding and the repository’s actual architecture boundaries (desktop host, shared Commons libraries, and plugin lifecycle), while refreshing community/update links.
Changes:
- Branded the root README with light/dark wordmarks, streamlined navigation, and added community/update links.
- Rewrote the architecture overview to match current plugin/helper/snapshot/trigger concepts and added a source map.
- Updated the interactive architecture HTML page and simplified the extending guide.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds branded header, refreshed navigation, and updated community/update links. |
| docs/system-architecture.html | Updates the interactive architecture narrative to match current shared helpers, snapshot usage, and plugin lifecycle; removes Chart.js content. |
| docs/extending/README.md | Removes the license-level section and keeps the extension loading guidance focused and concise. |
| docs/architecture.md | Replaces the older overview with a mermaid “at a glance” diagram, clearer component boundaries, lifecycle notes, and a source map. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Summary
Validation
git diff --checkpassed.