docs: add generated tutorial compatibility matrix (#212)

* docs: declare tutorial compatibility requirements

* docs: generate tutorial compatibility matrix

* fix: correct BPF Arena minimum kernel

* refactor: simplify compatibility validation

---------

Co-authored-by: LinuxDev9002 <i@littlefisher.me>
This commit is contained in:
云微
2026-07-14 05:00:48 -07:00
committed by GitHub
parent e08f604769
commit 37375ff87e
78 changed files with 1167 additions and 13 deletions

View File

@@ -8,6 +8,7 @@ on:
- 'src/**/README.zh.md'
- 'src/**/.config'
- 'scripts/generate_toc.py'
- 'scripts/generate_compatibility.py'
- 'scripts/*.template'
workflow_dispatch:
@@ -33,6 +34,7 @@ jobs:
- name: Generate documentation
run: |
python3 scripts/generate_toc.py
python3 scripts/generate_compatibility.py
- name: Check for changes
id: check_changes
@@ -44,6 +46,6 @@ jobs:
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md
git add README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md src/compatibility.md src/compatibility.zh.md
git commit -m "docs: auto-generate documentation"
git push

View File

@@ -14,10 +14,12 @@ jobs:
steps:
- uses: actions/checkout@v7
- name: Test documentation scripts
run: python3 -m unittest scripts.test_check_internal_links scripts.test_generate_toc
run: python3 -m unittest scripts.test_check_internal_links scripts.test_generate_toc scripts.test_generate_compatibility
- name: Regenerate documentation indexes
run: python3 scripts/generate_toc.py
run: |
python3 scripts/generate_toc.py
python3 scripts/generate_compatibility.py
- name: Verify generated documentation is current
run: git diff --exit-code -- README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md
run: git diff --exit-code -- README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md src/compatibility.md src/compatibility.zh.md
- name: Check relative Markdown links
run: python3 scripts/check_internal_links.py