docs
This commit is contained in:
parent
0e75fbda66
commit
4c11d08e7b
10
README.md
10
README.md
@ -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.
|
||||
|
||||
**➡️ [Go to the Full Documentation](docs/README.md)**
|
||||
**➡️ [Go to the Full Documentation](./docs/README.md)**
|
||||
|
||||
```bash
|
||||
# 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.
|
||||
|
||||
- **[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.
|
||||
- **[Project Context](`CONTEXT.md`)** - The single source of truth for the project's current state.
|
||||
- **[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.
|
||||
- **[Project Context](`./CONTEXT.md`)** - The single source of truth for the project's current state.
|
||||
|
||||
## 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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user