John O'Keefe
913174cdf8
TestDocsRelativeLinks walked only docs/developer; widening it to all of docs/ immediately surfaced the same class of rot the gate was built for, outside its old reach: - docs/index.md was the old monolith's landing page: linked the deleted api-reference.md, 10 directory-style area links, and escaped the docs tree to README/AGENTS/.env/compose. Rewritten as a portal whose every link resolves, with one representative endpoint doc per API area and pointers to the new writing-ui-docs.md standard. - directory-style links in user stubs (devices/, ../operations/) - case-mismatched links (Development.md) in contributing.md - monolith-era pointer (API_REFERENCE.md, TROUBLESHOOTING.md) and escaped AGENTS.md links in contributing/development.md - docs/development/calibre-opf-implementation.md double-up escapes, a link to the removed repo-root plan file (absorbed here), and a source-code hyperlink the docs site can't serve (now inline code) - operations/operations.md linked three never-written guide pages as aspirational links - they stay plain text until pages exist HANDS-OFF (project owner, 2026-11-02): docs/user/filters/** and docs/user/searching-and-filtering.md are exempt as link sources so no future checker failure can force edits to the filter documentation. Files linking INTO them remain checked.
37 lines
1.0 KiB
Markdown
37 lines
1.0 KiB
Markdown
# Contributing to Bookhoard
|
|
|
|
Welcome to the Bookhoard contributing documentation. This section contains guides for contributing to the Bookhoard project.
|
|
|
|
## 🚀 Getting Started
|
|
|
|
- **[Development Guide](development.md)** - Development workflow and architecture
|
|
- Architecture overview
|
|
- Directory structure
|
|
- Local development setup
|
|
- Testing guidelines
|
|
- Code style
|
|
- Deployment
|
|
|
|
## 📋 Project Guidelines
|
|
|
|
- **[AGENTS.md](../contributing/contributing.md)** - Development rules and standards live in the Contributing portal
|
|
- Critical prohibitions
|
|
- Mandatory requirements
|
|
- Error recovery protocol
|
|
- Workflow checklists
|
|
|
|
## 🤝 How to Contribute
|
|
|
|
We welcome contributions! Please see our [Development Guide](development.md) for information on:
|
|
|
|
- Setting up your development environment
|
|
- Understanding the codebase
|
|
- Making pull requests
|
|
- Code review process
|
|
- Testing requirements
|
|
|
|
---
|
|
|
|
**Looking for user documentation?** See the [User Portal](../user/user-guide.md)
|
|
**Need API docs?** See the [Developer Portal](../developer/development.md)
|