will/rxminder
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update main documentation index for simplified structure

Browse Source 
- Remove references to deleted migration and deployment documents
- Update file paths to reflect new organization structure
- Simplify navigation sections to focus on current development needs
- Remove broken links and obsolete sections
- Update documentation version to 3.0 to reflect major reorganization
This commit is contained in:
William Valentin
2025-09-08 21:37:35 -07:00
parent fdb0c78827
commit 280eb489e7
1 changed files with 17 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/README.md
View File

@@ -1,9 +1,4 @@
# 📚 Documenta#### 💻 Development
- **[API Documentation](development/API.md)** - REST API endpoints and usage
- **[Code Quality](development/CODE_QUALITY.md)** - Linting, formatting, and quality standards
- **[Application Security](development/APPLICATION_SECURITY.md)** - Application security practices
- **[Security Changes](development/SECURITY_CHANGES.md)** - Recent security updates and changesndex
# 📚 Documentation Index
Welcome to the RxMinder documentation! This guide will help you navigate through all available documentation organized by category.
@@ -16,27 +11,21 @@ Welcome to the RxMinder documentation! This guide will help you navigate through
- **[Complete Template Configuration](setup/COMPLETE_TEMPLATE_CONFIGURATION.md)** - Full setup guide
- **[Setup Complete](setup/SETUP_COMPLETE.md)** - Post-setup verification checklist
- **[Environment Variables](setup/ENVIRONMENT_VARIABLES.md)** - Environment configuration guide
- **[App Name Configuration](setup/APP_NAME_CONFIGURATION.md)** - Customizing application branding
## 💻 Development
- **[API Documentation](development/API.md)** - REST API endpoints and usage
- **[Database Service](development/DATABASE.md)** - Database abstraction layer and strategy pattern implementation
- **[Code Quality](development/CODE_QUALITY.md)** - Linting, formatting, and quality standards
- **[Security](development/SECURITY.md)** - Security guidelines and best practices
- **[Application Security](development/APPLICATION_SECURITY.md)** - Application security practices
- **[Security Changes](development/SECURITY_CHANGES.md)** - Recent security updates and changes
- **[Pre-commit Hooks](development/PRE_COMMIT_HOOKS.md)** - Git hook configuration and usage
## 🚢 Deployment
## 🔧 Implementation
- **[Deployment Guide](deployment/DEPLOYMENT.md)** - General deployment instructions
- **[Production Build Guide](deployment/PRODUCTION_BUILD.md)** - Production build configuration and security
- **[Docker Configuration](deployment/DOCKER_IMAGE_CONFIGURATION.md)** - Docker setup and configuration
- **[Gitea Setup](deployment/GITEA_SETUP.md)** - Gitea CI/CD configuration
- **[Storage Configuration](deployment/STORAGE_CONFIGURATION.md)** - Database and storage setup
## 🔄 Migration Guides
- **[NodeJS Pre-commit Migration](migration/NODEJS_PRECOMMIT_MIGRATION.md)** - Migration from Python to NodeJS pre-commit hooks
- **[Buildx Migration](migration/BUILDX_MIGRATION.md)** - Docker Buildx migration guide
- **[Implementation Summary](implementation/IMPLEMENTATION_SUMMARY.md)** - Current implementation status and features
## 📝 Project Information
@@ -45,11 +34,6 @@ Welcome to the RxMinder documentation! This guide will help you navigate through
- **[Changelog](../CHANGELOG.md)** - Version history and changes
- **[License](../LICENSE)** - Project license information
## 📋 Documentation Meta
- **[Documentation Reorganization](REORGANIZATION_SUMMARY.md)** - How we restructured the docs
- **[Docs Update Summary](DOCS_UPDATE_SUMMARY.md)** - Legacy documentation summary
## 🔍 Quick Navigation
### For New Developers
@@ -58,28 +42,24 @@ Welcome to the RxMinder documentation! This guide will help you navigate through
2. Review [Project Structure](architecture/PROJECT_STRUCTURE.md)
3. Follow [Complete Template Configuration](setup/COMPLETE_TEMPLATE_CONFIGURATION.md)
4. Read [Code Quality](development/CODE_QUALITY.md) guidelines
5. Set up [Pre-commit Hooks](development/PRE_COMMIT_HOOKS.md)
### For Deployment
1. Read [Deployment Guide](deployment/DEPLOYMENT.md)
2. Configure [Production Build](deployment/PRODUCTION_BUILD.md) for secure deployment
3. Configure [Docker](deployment/DOCKER_IMAGE_CONFIGURATION.md)
4. Set up [Storage](deployment/STORAGE_CONFIGURATION.md)
5. Review [Security](development/SECURITY.md) requirements
### For API Integration
### For Development
1. Check [API Documentation](development/API.md)
2. Review [Database Service](development/DATABASE.md) for data operations
3. Review [Security](development/SECURITY.md) requirements
3. Review [Application Security](development/APPLICATION_SECURITY.md) requirements
4. Configure [App Name](setup/APP_NAME_CONFIGURATION.md) for branding
5. Set up [Environment Variables](setup/ENVIRONMENT_VARIABLES.md)
### For Migration Tasks
### For Code Quality
1. [NodeJS Pre-commit Migration](migration/NODEJS_PRECOMMIT_MIGRATION.md) - For modernizing git hooks
2. [Buildx Migration](migration/BUILDX_MIGRATION.md) - For Docker build improvements
1. Read [Code Quality](development/CODE_QUALITY.md) standards
2. Configure [Pre-commit Hooks](development/PRE_COMMIT_HOOKS.md)
3. Review [Security Changes](development/SECURITY_CHANGES.md)
---
📋 **Last Updated:** January 2024
🔄 **Documentation Version:** 2.1
🔄 **Documentation Version:** 3.0
📦 **Project Version:** 0.0.0