62999b41d0
feat(docs): restructure documentation with new framework and templates
...
- 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
2025-11-16 13:32:10 +01:00
df439058a9
docs: replace 'Documentor' with 'Technical Writer' terminology
...
Hugo Site Tests / test (push) Failing after 1s
ci / build (push) Successful in 56s
- Renamed README-documentor.md → README-technical-writer.md
- Updated all references from "Documentor" to "Technical Writer" across:
- README files (README.md, README-developer.md, README-likec4.md)
- Content pages (documentation section, homepage)
- LikeC4 models (documentation-platform.c4 in both projects)
- Regenerated LikeC4 webcomponents with updated terminology
- Updated lowercase "documentor" to "technicalWriter" in model IDs
"Technical Writer" is the proper English term for documentation contributors,
replacing the non-standard "Documentor" terminology.
2025-11-07 15:57:14 +01:00
9e509ed265
docs: consolidate root documentation to README-* structure
...
ci / build (push) Successful in 53s
- Created README-documentor.md: comprehensive guide for content contributors
- Created README-likec4.md: architecture modeling guide (merged from README-ARCHITECTURE.md + LIKEC4-QUICKSTART.md)
- Enhanced README-developer.md:
- Added Docker/Container Build section (from DOCKER.md)
- Expanded Testing section (from TESTING.md)
- Added Version Management section (from VERSIONS.md)
- Added LikeC4 tasks reference
- Updated README.md: modernized with badges and clear structure
- Deleted redundant files:
- DOCUMENTOR-GUIDE.md (ASCII art, redundant to README-documentor.md)
- DOCKER.md (integrated into README-developer.md)
- TESTING.md (integrated into README-developer.md)
- README-ARCHITECTURE.md (merged into README-likec4.md)
- LIKEC4-QUICKSTART.md (merged into README-likec4.md)
- VERSIONS.md (integrated into README-developer.md)
- Added devbox shell step to local-development.md
All hands-on documentation now follows README-* naming convention.
RELEASE.md retained as process documentation (not hands-on guide).
2025-11-07 15:48:55 +01:00
a845e0fcde
chore(hugo): Added devbox for hugo processing. Improved README documentation.
2024-11-05 09:38:29 +01:00
d14bbf9a94
Added idpbuilder topic and added devcontainer cli support
2024-09-26 14:44:53 +02:00
a3e7cd3e27
fix(README): better Docsy installation description
2024-09-03 10:39:41 +02:00
361c0fe4a1
chore(hugo): adjusted README
2024-08-28 17:20:57 +02:00
7197520e31
chore(hugo): adjusted README
2024-08-28 17:17:01 +02:00
671f85e983
chore(hugo-them): adjusted README
2024-08-05 10:01:01 +00:00
92957dd8f8
doc(): added chapter structure, lots of links ... looks quite readable meanwhile :-)
2024-07-30 16:28:22 +02:00
86d0c47dd9
chore(documentation-base): added installation illustration to the README
2024-07-30 11:39:14 +02:00
Stephan Lo (WSL)
fabab52d8d
chore(documentation-base): Initial commit with Hugo devcontainer and RELEARN theme installed - just open the devconatiner and start editing!
2024-07-30 11:12:09 +02:00
