How frankframework/frank-manual works
Content Management Layer
• RST Source Files (in /docs/source)
• Configuration Files
• Example Frank Configs (in /src and /srcSteps)
• Images and Media Assets
Build Processing Layer
• Python Processing Scripts
• generateAll.py (main orchestrator)
• buildDownloadZips.py (zip file generator)
• createSnippets.py (snippet generator)
• TutorialSteps Module (Python package for processing tutorials)
• Build Configuration Files
Output Generation Layer
• Sphinx Documentation Generator
• ReadTheDocs Integration
• ZIP File Generation
• Snippet Generation
Deployment Layer
• GitHub Repository
• ReadTheDocs.io Platform
• Automated Build Hooks
• [Content Management] → [Build Processing] → [Output Generation] → [Deployment]
Component Representations
• Rectangles: Major system components
• Rounded rectangles: Processing units
• Hexagons: External services/platforms
Following relationships
• Content files → Python processors
• Python processors → Generated artifacts
• Generated artifacts → Sphinx
• Sphinx → ReadTheDocs
• GitHub → ReadTheDocs hooks
The integration with external platforms
This system design will help developers understand the documentation generation pipeline and how different components interact to produce the final documentation website.