@@ -45,31 +45,37 @@ The documentation follows the [Diátaxis framework](https://diataxis.fr/) princi
4545 - Telesurgery - Remote surgical operation
4646 - ` asset-catalog/ ` - ** Resources** : Pre-built simulation assets and AI models
4747 - ` sensor-simulation/ ` - ** Capabilities** : Physics-based medical sensor emulation
48- - ` how-to /` - ** Task Guides ** : Step-by-step instructions for specific tasks
49- - ` reference /` - ** Technical Reference ** : APIs, setup guides, and specifications
48+ - ` models /` - ** AI Models & Policies ** : Pre-trained models and control policies
49+ - ` sdg /` - ** Synthetic Data Generation ** : Tools for creating training data
5050 - ` assets/ ` - Images and static resources
5151- ` scripts/ ` - Documentation maintenance tools
5252 - ` sync_readmes.py ` - Synchronizes README files from source repositories
5353 - ` readme-sync-config.yml ` - Configuration for README synchronization
54- - ` sync_readmes .py` - Synchronizes README files and optionally fixes image paths
54+ - ` license_header_validator .py` - Validates and adds license headers to code files
5555- ` mkdocs.yml ` - MkDocs configuration
5656- ` .github/workflows/ ` - GitHub Actions for automated deployment
5757
5858## Automated Documentation Workflow
5959
6060The documentation is automatically built and deployed through GitHub Actions:
6161
62- 1 . ** On every push to main** , the workflow:
62+ 1 . ** Automated triggers** :
63+ - On every push to main
64+ - Weekly on Mondays at 00:00 UTC
65+ - Manual workflow dispatch
66+
67+ 2 . ** The workflow** :
6368 - Clones the three source repositories (i4h-asset-catalog, i4h-sensor-simulation, i4h-workflows)
64- - Runs the sync script to pull README content into the docs structure
69+ - Runs the sync script to pull latest README content
70+ - Validates all Python/shell files have proper license headers
6571 - Builds the MkDocs site
6672 - Deploys to GitHub Pages at https://isaac-for-healthcare.github.io/i4h/
6773
68- 2 . ** Content synchronization** is configured in ` scripts/readme-sync-config.yml ` , which maps:
74+ 3 . ** Content synchronization** is configured in ` scripts/readme-sync-config.yml ` , which maps:
6975 - Source README files from the three repositories
7076 - Target locations in the documentation structure
7177
72- 3 . ** To update documentation** :
78+ 4 . ** To update documentation** :
7379 - Direct edits: Modify files in ` docs/ ` directory
7480 - Synced content: Update README files in the source repositories
7581 - Navigation: Edit the ` nav ` section in ` mkdocs.yml `
@@ -110,16 +116,4 @@ mkdocs build --strict
110116
111117# Verbose output
112118mkdocs serve --verbose
113- ```
114-
115- ### Troubleshooting
116-
117- - ** Missing repositories** : Ensure source repositories are cloned before running sync
118- - ** Image issues** : Use ` python scripts/sync_readmes.py --fix-all-images ` for manual image repair
119- - ** Build errors** : Check for broken links or missing files with ` mkdocs build --strict `
120-
121- ## Support
122-
123- - Documentation site: https://isaac-for-healthcare.github.io/i4h/
124- - GitHub repository: https://github.com/isaac-for-healthcare/i4h-docs
125- - Issue tracker: https://github.com/isaac-for-healthcare/i4h-docs/issues
119+ ```
0 commit comments