vasily/TCPDashboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Ajasra 2025-06-07 14:19:50 +08:00
parent 0e75fbda66
commit 4c11d08e7b
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -28,7 +28,7 @@ This platform enables rapid strategy development with a monolithic architecture
For detailed instructions on setting up and running the project, please refer to the main documentation. For detailed instructions on setting up and running the project, please refer to the main documentation.
**➡️ [Go to the Full Documentation](docs/README.md)** **➡️ [Go to the Full Documentation](./docs/README.md)**
```bash ```bash
# Quick setup for development # Quick setup for development
@ -44,10 +44,10 @@ uv run python main.py
All project documentation is located in the `docs/` directory. The best place to start is the main documentation index. All project documentation is located in the `docs/` directory. The best place to start is the main documentation index.
- **[Main Documentation](`docs/README.md`)** - The central hub for all project documentation, including setup guides, architecture, and module details. - **[Main Documentation](`./docs/README.md`)** - The central hub for all project documentation, including setup guides, architecture, and module details.
- **[Setup Guide](`docs/guides/setup.md`)** - Complete setup instructions for new machines. - **[Setup Guide](`./docs/guides/setup.md`)** - Complete setup instructions for new machines.
- **[Project Context](`CONTEXT.md`)** - The single source of truth for the project's current state. - **[Project Context](`./CONTEXT.md`)** - The single source of truth for the project's current state.
## Contributing ## Contributing
We welcome contributions! Please review the **[Contributing Guidelines](`docs/CONTRIBUTING.md`)** and the **[Project Context](`CONTEXT.md`)** before getting started. We welcome contributions! Please review the **[Contributing Guidelines](`./docs/CONTRIBUTING.md`)** and the **[Project Context](`./CONTEXT.md`)** before getting started.