feat: slim readme + ci site deployment

README: 11141 -> 43 lines. Details on the MkDocs site.
generate_readme.py: 444 -> 164 lines. Slim coverage table only.
build.yml: adds mkdocs-material install, generate_site.py, gh-deploy.
Adds pages: write permission for GitHub Pages deployment.
This commit is contained in:
Abdessamad Derraz
2026-03-18 10:44:13 +01:00
parent 32e4f6e580
commit 21a50c992f
4 changed files with 139 additions and 11547 deletions

View File

@@ -13,6 +13,7 @@ on:
permissions:
contents: write
pages: write
concurrency:
group: build
@@ -49,10 +50,16 @@ jobs:
env:
GH_TOKEN: ${{ github.token }}
- name: Regenerate database and docs
- name: Regenerate database, readme, and site
run: |
pip install mkdocs-material
python scripts/generate_db.py --force --bios-dir bios --output database.json
python scripts/generate_readme.py --db database.json --platforms-dir platforms
python scripts/generate_site.py
- name: Deploy site to GitHub Pages
if: github.ref == 'refs/heads/main'
run: mkdocs gh-deploy --force --clean
- name: Commit if changed
id: commit