43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
---
|
|
title: "Documentation About Documentation"
|
|
linkTitle: "Documentation"
|
|
weight: 10
|
|
description: >
|
|
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:
|
|
|
|
1. [Local Development](local-development/) - How to work on documentation locally
|
|
2. [Testing](testing/) - Quality assurance processes
|
|
3. [CI/CD Pipeline](cicd/) - Automated testing and deployment
|
|
4. [Publishing](publishing/) - How documentation reaches production
|