Clarify README documentation links and guidance - #72
Merged
Conversation
silahian
commented
Aug 20, 2026
silahian
commented
Collaborator
- Main "Documentation" link now points to the public website
- Added "OSS doc sources" link to Markdown files in repo
- Setup help directs users to public docs, troubleshooting, or Discord
- Explained that website is built from repo Markdown, which is canonical
- Instructed contributors to update only repo Markdown files
- Clarified documentation guide links
- Main "Documentation" link now points to the public website - Added "OSS doc sources" link to Markdown files in repo - Setup help directs users to public docs, troubleshooting, or Discord - Explained that website is built from repo Markdown, which is canonical - Instructed contributors to update only repo Markdown files - Clarified documentation guide links
There was a problem hiding this comment.
Pull request overview
Updates top-level documentation guidance to clearly direct users to the public docs experience while emphasizing that the repository Markdown remains the canonical, editable source of truth.
Changes:
- Updated the primary “Documentation” link in the root README to point to
visualhft.com/docsand added an explicit link to the repo’s Markdown doc sources. - Improved setup help text to direct users to public docs, troubleshooting source, or Discord.
- Clarified in
docs/README.mdthat the website projects content from pinned repo sources and contributors should update repo Markdown only.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Repoints documentation link to the public docs site and adds a link to the repo doc sources, plus clearer setup help routing. |
| docs/README.md | Clarifies the relationship between the public docs site and the repo Markdown as the canonical editable sources. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Use this guide to install VisualHFT, understand its public architecture, and build extensions. | ||
| The branded public documentation experience is available at [visualhft.com/docs](https://visualhft.com/docs). | ||
|
|
||
| The Markdown files in this directory remain the canonical editable sources for open-source build, architecture, extension, and troubleshooting guidance. The website projects an explicit allowlist from a pinned repository commit and links every projected page back here. Update the source in this repository; do not maintain a second copy in the website. |
| <a href="https://visualhft.com">Website</a> · | ||
| <a href="docs/README.md">Documentation</a> · | ||
| <a href="https://visualhft.com/docs">Documentation</a> · | ||
| <a href="docs/README.md">OSS doc sources</a> · |
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.