d.viti
|
6c4e40400a
|
Move all documentation to web/docs for MkDocs integration
Helm Chart Build / lint-only (push) Has been skipped
Helm Chart Build / build-helm (push) Successful in 9s
Build and Deploy / build-api (push) Successful in 42s
Build and Deploy / build-web (push) Successful in 1m5s
Moved all documentation files into web/docs/ directory for proper
MkDocs integration and updated navigation structure.
Changes:
========
1. Documentation Structure:
- Moved SWAGGER-WEB-UPDATE.md → web/docs/swagger-documentation.md
- Moved ARGOCD-VALUES-UPDATE.md → web/docs/argocd-values-guide.md
- Formatted both files with MkDocs frontmatter and structure
2. MkDocs Navigation (web/mkdocs.yml):
- Updated site_url to https://commandware.it/docs
- Added new section "API Documentation" with Swagger guide
- Added "ArgoCD Values Guide" to Configuration section
- Enhanced markdown extensions:
* Added mermaid diagram support
* Added task lists
* Added emoji support
* Added code annotations
- Added navigation features (instant, tabs, sections)
- Added tags plugin
- Improved copyright notice
3. Swagger Documentation (web/docs/swagger-documentation.md):
- Complete guide to Swagger UI, ReDoc, and OpenAPI
- Access instructions via web interface and direct links
- API overview with architecture diagram
- Detailed endpoint documentation for all groups:
* Root (/)
* Health (/health, /ready)
* Items CRUD (/items/*)
* Users (/users/*)
* LLM (/llm/*)
- Interactive testing examples
- OpenAPI specification download instructions
- Tools integration (Postman, Insomnia, OpenAPI Generator)
- Cross-references to other documentation pages
4. ArgoCD Values Guide (web/docs/argocd-values-guide.md):
- Comprehensive guide for updating values.yaml in ArgoCD
- All modifications explained (before/after)
- Step-by-step application instructions
- Verification commands
- Security best practices
New MkDocs Navigation:
======================
- Home
- Getting Started
- Architecture
- Overview
- Kubernetes Resources
- Configuration
- API7 Gateway
- Ingress & Routing
- Service Discovery
- Secret Management
- ArgoCD Values Guide ← NEW
- CI/CD Pipeline
- API Documentation ← NEW SECTION
- Swagger & OpenAPI
- Troubleshooting
All documentation is now centralized in web/docs/ and accessible
through MkDocs at https://commandware.it/docs
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
|
2025-10-09 17:24:53 +02:00 |
|