Skip to content

Commit f9bba0b

Browse files
docs: use readthedocs urls for root docs to bypass sphinx xref issues
1 parent 4ae149e commit f9bba0b

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Edit > Preferences > Get Extensions > Install from Disk
4343
```
4444

4545
**Documentation:**
46-
- [Architecture Guide](https://github.com/arounamounchili/linkforge/blob/main/docs/source/explanation/ARCHITECTURE.md)
46+
- [Architecture Guide](https://linkforge.readthedocs.io/en/latest/explanation/ARCHITECTURE.html)
4747
- [Contributing Guide](CONTRIBUTING.md)
4848

4949
**Contributors:**

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ linkforge/
9393
└── build_extension.py # Extension builder script
9494
```
9595

96-
See [ARCHITECTURE](docs/source/explanation/ARCHITECTURE.md) for detailed architecture diagrams.
96+
See [ARCHITECTURE](https://linkforge.readthedocs.io/en/latest/explanation/ARCHITECTURE.html) for detailed architecture diagrams.
9797

9898
## Development Workflow
9999

@@ -455,7 +455,7 @@ subprocess.run(["pytest", "tests/integration/"])
455455

456456
## Getting Help
457457

458-
- **Documentation**: Check [ARCHITECTURE](docs/source/explanation/ARCHITECTURE.md) and [README.md](README.md)
458+
- **Documentation**: Check [ARCHITECTURE](https://linkforge.readthedocs.io/en/latest/explanation/ARCHITECTURE.html) and [README.md](README.md)
459459
- **Issues**: Search [existing issues](https://github.com/arounamounchili/linkforge/issues)
460460
- **Discussions**: Ask in [GitHub Discussions](https://github.com/arounamounchili/linkforge/discussions)
461461

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ LinkForge uses a "Self-Contained" bundling strategy for wheels. To update or add
181181
## 📚 Documentation
182182

183183
- **[Read the Docs](https://linkforge.readthedocs.io/)** - Complete documentation
184-
- **[Architecture Guide](https://github.com/arounamounchili/linkforge/blob/main/docs/source/explanation/ARCHITECTURE.md)** - System design with diagrams
184+
- **[Architecture Guide](https://linkforge.readthedocs.io/en/latest/explanation/ARCHITECTURE.html)** - System design with diagrams
185185
- **[API Reference](https://linkforge.readthedocs.io/en/latest/reference/api/)** - Programmatic usage
186186
- **[Getting Started](https://linkforge.readthedocs.io/en/latest/tutorials/index.html)** - User guide
187187
- **[CHANGELOG](CHANGELOG.md)** - Version history

0 commit comments

Comments
 (0)