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
33 lines
767 B
Markdown
33 lines
767 B
Markdown
# EDP - Edge Developer Platform
|
|
|
|
Documentation for the edgeDeveloperFramework (eDF) project and the resulting Edge Developer Platform (EDP) product suite.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Install dependencies
|
|
task deps
|
|
|
|
# Start local development server
|
|
task serve
|
|
|
|
# Run tests
|
|
task test
|
|
|
|
# Build production site
|
|
task build
|
|
```
|
|
|
|
## Documentation
|
|
|
|
* [Developer Guide](doc/README-developer.md)
|
|
* [Technical Writer Guide](doc/README-technical-writer.md)
|
|
* [Release Notes](doc/RELEASE.md)
|
|
|
|
## Project
|
|
|
|
This is a Hugo-based documentation site for the Edge Developer Platform, built as part of the IPCEI-CIS project.
|
|
|
|
**Website:** Access the documentation at the deployed URL or run locally with `task serve`
|
|
|
|
For detailed information, see the documentation in the `doc/` folder.
|