Skip to content

Clarify README documentation links and guidance #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
silahian merged 1 commit into from
Aug 20, 2026
Merged

Clarify README documentation links and guidance #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@

<p align="center">
<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> ·
<a href="https://visualhft.com/discord">Discord</a> ·
<a href="https://github.com/visualHFT/VisualHFT/discussions">Discussions</a>
</p>
Expand Down Expand Up @@ -57,7 +58,7 @@ git clone https://github.com/visualHFT/VisualHFT.git

Open `VisualHFT/VisualHFT.sln` in Visual Studio and build the solution. Set `VisualHFT` as the startup project and press <kbd>F5</kbd>. The Dashboard opens first. Select an available provider and a normalised symbol such as `BTC/USD` in the order-book panel.

Need help with setup? See [Troubleshooting](docs/troubleshooting.md) or ask in [Discord](https://visualhft.com/discord).
Need help with setup? Use the public [VisualHFT documentation](https://visualhft.com/docs), see the repository [troubleshooting source](docs/troubleshooting.md), or ask in [Discord](https://visualhft.com/discord).

## Included in this repository

Expand Down
6 changes: 5 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# VisualHFT documentation

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.

Use these source guides to install VisualHFT, understand its public architecture, and build extensions:

- [Getting started](getting-started.md)
- [Architecture](architecture.md)
Expand Down