mirror of
https://github.com/ankitects/anki.git
synced 2026-07-28 23:10:45 -04:00
fb0215a2c1
## Summary - add a generated `docs-site/` Mintlify proof of concept for a unified Anki docs site - migrate the desktop manual, AnkiMobile docs, FAQs, add-on docs, translation docs, release notes, legacy docs, and repo-local Sphinx/MyST developer docs into the POC tree - add a migration helper that preserves mdBook ordering, handles common MDX incompatibilities, and regenerates the landing-page-inspired Mintlify styling - apply minimal styling based on the current Anki landing page: Anki logo, Hanken Grotesk, blue primary color, subtle surfaces, and compact nav treatment ## Validation - `uv run --with ty ty check tools/mintlify_poc_migrate.py` - `source ~/.nvm/nvm.sh && nvm use 22.15.0 && mint validate` - previewed locally with `mint dev --port 3000` and checked the home page/developer docs in browser ## Notes This is intentionally a draft POC. It does not remove the existing Sphinx or mdBook docs flows yet; it demonstrates what bringing the sources into this repo and building from a single Mintlify root could look like. --------- Co-authored-by: Andrew Sanchez <andrewsanchez@users.noreply.github.com> Co-authored-by: Luc Mcgrady <lucmcgrady@gmail.com> Co-authored-by: Abdo <abdo@abdnh.net>
45 lines
1.1 KiB
YAML
45 lines
1.1 KiB
YAML
name: Docs Site
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
paths:
|
|
- ".github/workflows/docs-site.yml"
|
|
- "docs-site/**"
|
|
- "pylib/tools/genhooks.py"
|
|
- "pylib/tools/hookslib.py"
|
|
- "qt/tools/genhooks_gui.py"
|
|
- "tools/mintlify_hooks.py"
|
|
- "tools/tests/test_mintlify_hooks.py"
|
|
|
|
jobs:
|
|
validate:
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 #v4
|
|
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@94527f2e458b27549849d47d273a16bec83a01e9 #v7
|
|
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 #v4
|
|
with:
|
|
node-version: "22.15.0"
|
|
|
|
- name: Install Mintlify CLI
|
|
run: npm install -g mintlify
|
|
|
|
- name: Test docs generation
|
|
run: uv run python -m pytest tools/tests/test_mintlify_hooks.py
|
|
|
|
- name: Validate Mintlify docs
|
|
run: mintlify validate
|
|
working-directory: docs-site
|
|
|
|
- name: Check for accessibility issues
|
|
run: mintlify a11y --skip-contrast
|
|
working-directory: docs-site
|