docs: fix broken references and update paths

- Update README.md to remove references to deleted migration/deployment docs
- Fix CONTRIBUTING.md to point to correct documentation paths
- Remove broken references in API.md to non-existent files
- Update ENVIRONMENT_VARIABLES.md to reference existing documentation
- Ensure all documentation links work correctly after reorganization
This commit is contained in:
William Valentin
2025-09-08 21:38:07 -07:00
parent fd82b7755b
commit 36dcdbd459
3 changed files with 11 additions and 20 deletions

View File

@@ -484,9 +484,9 @@ docker compose -f docker/docker-compose.yaml down # Stop services
### Documentation
- [README.md](README.md) - Project overview and setup
- [docs/API.md](docs/API.md) - API documentation
- [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) - Deployment guide
- [docs/SECURITY.md](docs/SECURITY.md) - Security guidelines
- [docs/development/API.md](docs/development/API.md) - API documentation
- [docs/development/APPLICATION_SECURITY.md](docs/development/APPLICATION_SECURITY.md) - Security guidelines
- [docs/development/CODE_QUALITY.md](docs/development/CODE_QUALITY.md) - Code quality standards
### Community

View File

@@ -775,16 +775,9 @@ For comprehensive documentation, visit **[`docs/README.md`](docs/README.md)** wh
- [Code Quality](docs/development/CODE_QUALITY.md) - Quality standards & tools
- [Application Security](docs/development/APPLICATION_SECURITY.md) - App security practices
#### 🚢 Deployment
#### 🔧 Implementation
- [Deployment Guide](docs/deployment/DEPLOYMENT.md) - General deployment
- [Docker Configuration](docs/deployment/DOCKER_IMAGE_CONFIGURATION.md) - Docker setup
- [Gitea Setup](docs/deployment/GITEA_SETUP.md) - CI/CD configuration
#### 🔄 Migration Guides
- [NodeJS Pre-commit Migration](docs/migration/NODEJS_PRECOMMIT_MIGRATION.md) - Modern git hooks
- [Buildx Migration](docs/migration/BUILDX_MIGRATION.md) - Docker improvements
- [Implementation Summary](docs/implementation/IMPLEMENTATION_SUMMARY.md) - Current features and status
## 📚 Additional Resources
@@ -837,10 +830,9 @@ bun test-production.js
### **Project Documentation**
- **[Code Quality Guide](docs/CODE_QUALITY.md)** - Code formatting, linting, and pre-commit hooks setup
- **[Security Guide](docs/SECURITY.md)** - Security best practices and configuration
- **[Deployment Guide](docs/DEPLOYMENT.md)** - Production deployment instructions
- **[API Documentation](docs/API.md)** - Complete API reference
- **[Code Quality Guide](docs/development/CODE_QUALITY.md)** - Code formatting, linting, and pre-commit hooks setup
- **[Security Guide](docs/development/APPLICATION_SECURITY.md)** - Security best practices and configuration
- **[API Documentation](docs/development/API.md)** - Complete API reference
- **[Contributing Guide](CONTRIBUTING.md)** - Development guidelines and contribution process
- **[License](LICENSE)** - MIT license and third-party attributions
- **[Changelog](CHANGELOG.md)** - Version history and release notes

View File

@@ -833,7 +833,6 @@ X-RateLimit-Reset: 1693929600
## 📚 Additional Resources
- [Postman Collection](./postman-collection.json)
- [OpenAPI Specification](./openapi.yaml)
- [SDK Documentation](./sdk-docs.md)
- [Integration Examples](./examples/)
- [Database Service](DATABASE.md) - Database abstraction layer documentation
- [Application Security](APPLICATION_SECURITY.md) - Security practices and guidelines
- [Code Quality](CODE_QUALITY.md) - Development standards and best practices