- Add title parameter documentation to all relevant README files
- Update DOCUMENTOR-GUIDE.md with title parameter example
- Enhance quick-reference.md with complete parameter list
- Update INTEGRATION.md with recommended shortcode usage
- Simplify highlevelarch.md by using shortcode with title parameter
Added two complementary quick-start guides to help new contributors get
productive quickly without reading extensive documentation.
DOCUMENTOR-GUIDE.md:
- Quick-start guide for new documentation contributors
- Covers essential workflows: local dev, testing, committing
- Provides command reference for common tasks
- Links to detailed documentation platform guides
- Targets: writers, editors, content contributors
- Goal: Productive in 5 minutes
README-ARCHITECTURE.md:
- Quick-start guide for architecture diagram contributors
- Explains LikeC4 setup and project structure
- Covers both edp-likec4 (platform) and doc-likec4 (meta-docs) projects
- Provides regeneration workflow for webcomponents
- Targets: architects, system designers, technical writers
- Goal: Productive diagram editing in 5 minutes
These guides complement the detailed documentation in content/en/docs/documentation/
by providing a fast-track onboarding path. New contributors can start with these
quick-start guides and refer to detailed documentation as needed.
Documentation hierarchy:
1. Quick-start (these guides) - Get started in minutes
2. Full guides (content/en/docs/documentation/) - Comprehensive workflows
3. Architecture diagrams - Visual learning and exploration
Benefits:
- Reduced onboarding time for new team members
- Self-service documentation for common tasks
- Clear separation between quick reference and detailed guides
- Consistent documentation patterns across roles
