-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Description
Add Composer scripts to build and preview documentation using TYPO3's official render-guides Docker container.
Current State
- No documentation build scripts in composer.json
- Manual documentation building required
- TYPO3 Conformance Report: Excellence Indicators +1 point missing
Proposed Changes
Add the following scripts to composer.json:
{
"scripts": {
"docs:build": [
"docker run --rm -v $(pwd):/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation"
],
"docs:watch": [
"@docs:build --watch"
],
"docs:serve": [
"@docs:build --serve"
],
"docs:clean": [
"rm -rf Documentation-GENERATED-temp"
]
}
}Usage
After implementation:
# Build documentation once
composer docs:build
# Build and watch for changes (auto-rebuild)
composer docs:watch
# Build and serve with live preview
composer docs:serve
# Clean generated files
composer docs:cleanBenefits
- Easy documentation building
- Consistent with TYPO3 documentation workflow
- Official
render-guidescontainer - Live preview during editing
- CI/CD integration possible
Acceptance Criteria
- Scripts added to composer.json
- Documentation builds successfully with
composer docs:build - Watch mode works with
composer docs:watch - Serve mode works with
composer docs:serve - Clean command removes generated files
- README updated with documentation build instructions
References
Priority
Low - Developer quality of life improvement
Related
TYPO3 Conformance Report: Excellence Indicators +1 point
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request