DevFW-CICD/website-and-documentation
23
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
194 commits 14 branches 5 tags 53 MiB
Commit graph

3 commits

Author SHA1 Message Date
Stephan Lo
df439058a9 docs: replace 'Documentor' with 'Technical Writer' terminology
Some checks failed
Hugo Site Tests / test (push) Failing after 1s
Details
ci / build (push) Successful in 56s
Details 
- 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
Stephan Lo
9e509ed265 docs: consolidate root documentation to README-* structure
All checks were successful
ci / build (push) Successful in 53s
Details 
- 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
Stephan Lo
3eaa574a26 docs(dev): add Taskfile and developer documentation 
- Add Taskfile.yml with common development tasks
- Add go-task to devbox dependencies
- Create comprehensive README-developer.md covering:
  - Devbox setup and usage
  - Hugo and Docsy basics
  - Task commands reference
  - Development workflow
  - Content creation guide
  - Testing procedures
  - Troubleshooting tips
 2025-10-23 14:13:31 +02:00