mirror of
https://github.com/jackwener/OpenCLI.git
synced 2026-09-14 18:25:42 +08:00
AlexYue
15d3583c60
* docs: add missing adapter docs, fix sidebar 404s, add doc-check CI - Add doc pages for 11 undocumented adapters: arxiv, barchart, chaoxing, grok, hf, jike, jimeng, linux-do, sinafinance, stackoverflow, weread, wikipedia - Update adapters/index.md with all new adapter entries - Update VitePress sidebar config with 12 new entries - Remove broken zh/ sidebar refs (troubleshooting, testing) - Add doc-check CI workflow (adapter coverage + build + link check) - Add scripts/check-doc-coverage.sh for adapter doc enforcement - Enhance PR template with adapter doc checklist * fix(ci): use --root-dir instead of --base for lychee link checker lychee v0.23 requires --base to be a URL or absolute path. Use --root-dir for resolving root-relative links in local files. * fix(ci): remove lychee link-check job, rely on VitePress build VitePress links use extension-less paths (e.g. /adapters/browser/twitter) which lychee cannot resolve. The docs-build job already catches all broken internal links via VitePress dead link detection during build.
37 lines
761 B
YAML
37 lines
761 B
YAML
name: Doc Check
|
|
|
|
on:
|
|
pull_request:
|
|
branches: [main, dev]
|
|
|
|
concurrency:
|
|
group: doc-check-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
# ── Adapter doc coverage ──
|
|
doc-coverage:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Check adapter doc coverage
|
|
run: bash scripts/check-doc-coverage.sh --strict
|
|
|
|
# ── VitePress build validation ──
|
|
docs-build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: '22'
|
|
cache: 'npm'
|
|
|
|
- name: Install dependencies
|
|
run: npm ci
|
|
|
|
- name: Build docs (catches broken links & sidebar refs)
|
|
run: npm run docs:build
|