Skip to content

Commit 422e6d4

Browse files
author
fer
committed
Update GitHub Pages documentation to sync with current READMEs
Major updates to GitHub Pages documentation system: **Documentation Sync System**: - Create sync-readme-docs.py script to automatically copy main README and module READMEs to docs/ - Main README → docs/index.md for MkDocs homepage - Module READMEs → docs/modules/ for organized module documentation - Root documentation files copied to docs/ for navigation **MkDocs Configuration Updates**: - Updated mkdocs.yml to use synced documentation files - Fixed YAML syntax and indentation issues - Added comprehensive module documentation section - Organized navigation with Core Documentation and Module Documentation sections - Added all major TNFR documentation files to navigation **GitHub Actions Integration**: - Updated deploy-docs.yml and docs.yml workflows to run sync script before build - Configured triggers for README.md and module README changes - Added pattern matching for *.md files to ensure comprehensive updates **Result**: GitHub Pages now automatically reflects current state of: - Main repository README as homepage - All module READMEs in organized navigation - Core TNFR documentation (AGENTS.md, UNIFIED_GRAMMAR_RULES.md, etc.) - Automatic updates when any README is modified This creates a single source of truth where GitHub Pages documentation stays synchronized with repository documentation automatically.
1 parent 85960ae commit 422e6d4

20 files changed

+5677
-104
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ on:
88
- 'docs/**'
99
- 'mkdocs.yml'
1010
- '.github/workflows/deploy-docs.yml'
11+
- 'README.md'
12+
- 'src/**/README.md'
13+
- '*.md'
1114
workflow_dispatch:
1215

1316
permissions:
@@ -35,6 +38,10 @@ jobs:
3538
python -m pip install --upgrade pip
3639
python -m pip install -r docs/requirements.txt
3740
41+
- name: Sync README files
42+
run: |
43+
python scripts/sync-readme-docs.py
44+
3845
- name: Build MkDocs site
3946
run: |
4047
mkdocs build --clean

.github/workflows/docs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ on:
88
paths:
99
- 'mkdocs.yml'
1010
- 'docs/**'
11+
- 'README.md'
12+
- 'src/**/README.md'
13+
- '*.md'
1114

1215
jobs:
1316
build-deploy:
@@ -28,6 +31,10 @@ jobs:
2831
python -m pip install --upgrade pip
2932
pip install -r docs/requirements.txt
3033
34+
- name: Sync README files
35+
run: |
36+
python scripts/sync-readme-docs.py
37+
3138
- name: Build docs
3239
run: |
3340
mkdocs build

0 commit comments

Comments
 (0)