Stephan Lo
62999b41d0
- Archive old docs to docs-old/ for reference - Create new top-down documentation structure: * Platform Overview: purpose, audience, product structure * Components: individual platform components (Forgejo, Kubernetes, Backstage) * Getting Started: onboarding and quick start guides * Operations: deployment, monitoring, troubleshooting * Governance: ADRs, project history, compliance - Add DOCUMENTATION-GUIDE.md with writing guidelines and templates - Add component template (TEMPLATE.md) for consistent documentation - Simplify root README and move technical docs to doc/ folder - Update test configuration: * Exclude legacy content from markdown linting * Relax HTML validation for theme-generated content * Skip link checking for legacy content in test:links * Keep 'task test' clean for technical writers (100% pass) * Add 'task test:full' with comprehensive link checking - Update home page with corrected markdown syntax - Fix internal links in archived content BREAKING CHANGE: Documentation structure changed from flat to hierarchical top-down approach
1.5 KiB
1.5 KiB
| title | linkTitle | weight | description |
|---|---|---|---|
| Documentation About Documentation | Documentation | 10 | Learn how to create, maintain, and publish documentation for the developer platform. |
Welcome to the meta-documentation! This section explains how our documentation platform works and guides you through the technicalWriter role.
What is a Technical Writer?
A Technical Writer is responsible for creating, maintaining, and publishing the developer platform documentation. This includes:
- Writing and updating content in Markdown
- Creating architecture diagrams with LikeC4
- Testing locally before committing
- Following the CI/CD pipeline to production
Documentation Platform Architecture
Our documentation is built on a modern stack:
- Hugo with the Docsy theme for static site generation
- LikeC4 for architecture visualization
- Taskfile for local development automation
- GitHub Actions for continuous testing
- Edge deployment for hosting
System Overview
{{< likec4-view view="overview" project="documentation-platform" >}}
This high-level view shows all major components of the documentation platform.
Getting Started
Continue to the next sections to learn about:
- Local Development - How to work on documentation locally
- Testing - Quality assurance processes
- CI/CD Pipeline - Automated testing and deployment
- Publishing - How documentation reaches production