Public Access
docs: wrap README lines for markdownlint compliance
This commit is contained in:
@@ -1,6 +1,7 @@
|
|||||||
# Plex Playlist Project
|
# Plex Playlist Project
|
||||||
|
|
||||||
A full-stack application for managing Plex playlists with a FastAPI backend and Vue.js frontend.
|
A full-stack application for managing Plex playlists with a FastAPI backend
|
||||||
|
and Vue.js frontend.
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
@@ -282,24 +283,43 @@ npm run dev
|
|||||||
|
|
||||||
### Development & Workflow
|
### Development & Workflow
|
||||||
|
|
||||||
- **[Development Environment Setup](docs/DEVELOPMENT.md)** - Comprehensive guide for setting up your development environment, git workflow, pre-commit hooks, manual tool usage, and CI/CD pipeline understanding
|
- **[Development Environment Setup](docs/DEVELOPMENT.md)**
|
||||||
- **[Poe Task Reference](docs/POE_TASK_REFERENCE.md)** - Complete guide to unified development tasks and workflows using Poe the Poet
|
- Comprehensive guide for setting up your development environment,
|
||||||
- **[Deployable Runtime Contract](docs/DEPLOYABLE_RUNTIME_CONTRACT.md)** - Canonical backend/frontend deployable runtime image requirements and exclusions
|
git workflow, pre-commit hooks, manual tool usage, and CI/CD pipeline
|
||||||
- **[ADR003: Deployable Runtime Image Contract Boundaries](docs/adr/ADR003-deployable_runtime_image_contract.md)** - Architectural decision that locks deployable image boundary policy
|
understanding
|
||||||
|
- **[Poe Task Reference](docs/POE_TASK_REFERENCE.md)**
|
||||||
|
- Complete guide to unified development tasks and workflows using
|
||||||
|
Poe the Poet
|
||||||
|
- **[Deployable Runtime Contract](docs/DEPLOYABLE_RUNTIME_CONTRACT.md)**
|
||||||
|
- Canonical backend/frontend deployable runtime image requirements
|
||||||
|
and exclusions
|
||||||
|
- **[ADR003: Deployable Runtime Image Contract Boundaries](docs/adr/ADR003-deployable_runtime_image_contract.md)**
|
||||||
|
- Architectural decision that locks deployable image boundary policy
|
||||||
|
|
||||||
### Architecture & CI/CD
|
### Architecture & CI/CD
|
||||||
|
|
||||||
- **[CI/CD Multi-stage Build](docs/CICD_MULTI_STAGE_BUILD.md)** - Docker multi-stage build strategy, architecture decisions, and performance optimizations
|
- **[CI/CD Multi-stage Build](docs/CICD_MULTI_STAGE_BUILD.md)**
|
||||||
- **[CI/CD Troubleshooting Guide](docs/CICD_TROUBLESHOOTING_GUIDE.md)** - Comprehensive troubleshooting, optimization decisions, and performance monitoring for Docker builds and E2E testing
|
- Docker multi-stage build strategy, architecture decisions,
|
||||||
- **[CI/CD Success Summary](docs/CICD_SUCCESS_SUMMARY.md)** - Complete validation results and performance metrics for the optimized pipeline
|
and performance optimizations
|
||||||
|
- **[CI/CD Troubleshooting Guide](docs/CICD_TROUBLESHOOTING_GUIDE.md)**
|
||||||
|
- Comprehensive troubleshooting, optimization decisions,
|
||||||
|
and performance monitoring for Docker builds and E2E testing
|
||||||
|
- **[CI/CD Success Summary](docs/CICD_SUCCESS_SUMMARY.md)**
|
||||||
|
- Complete validation results and performance metrics
|
||||||
|
for the optimized pipeline
|
||||||
|
|
||||||
### Dependency Management & Automation
|
### Dependency Management & Automation
|
||||||
|
|
||||||
- **[Renovate Bot Setup](docs/RENOVATE_SETUP_GUIDE.md)** - Automated dependency updates with Renovate for Python, Node.js, and Docker dependencies
|
- **[Renovate Bot Setup](docs/RENOVATE_SETUP_GUIDE.md)**
|
||||||
|
- Automated dependency updates with Renovate for Python,
|
||||||
|
Node.js, and Docker dependencies
|
||||||
|
|
||||||
### Operations & Troubleshooting
|
### Operations & Troubleshooting
|
||||||
|
|
||||||
- **[Gitea Actions Troubleshooting](docs/GITEA_ACTIONS_TROUBLESHOOTING.md)** - Solutions for CI/CD pipeline issues, including the critical "jobs waiting forever" problem
|
- **[Gitea Actions Troubleshooting](docs/GITEA_ACTIONS_TROUBLESHOOTING.md)**
|
||||||
- **[Secure Docker CI/CD](docs/SECURE_DOCKER_CICD.md)** - Security considerations and setup for Docker-based CI/CD pipelines
|
- Solutions for CI/CD pipeline issues,
|
||||||
|
including the critical "jobs waiting forever" problem
|
||||||
|
- **[Secure Docker CI/CD](docs/SECURE_DOCKER_CICD.md)**
|
||||||
|
- Security considerations and setup for Docker-based CI/CD pipelines
|
||||||
|
|
||||||
See the `backend/` and `frontend/` folders for more details.
|
See the `backend/` and `frontend/` folders for more details.
|
||||||
|
|||||||
Reference in New Issue
Block a user