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.
70 lines
1.8 KiB
Bash
Executable File
70 lines
1.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# check-doc-coverage.sh — Verify every adapter in src/clis/ has a doc page.
|
|
#
|
|
# Exit codes:
|
|
# 0 — all adapters have docs
|
|
# 1 — at least one adapter is missing documentation
|
|
#
|
|
# Usage:
|
|
# bash scripts/check-doc-coverage.sh # report only
|
|
# bash scripts/check-doc-coverage.sh --strict # exit 1 on missing docs
|
|
|
|
set -euo pipefail
|
|
|
|
STRICT=false
|
|
if [[ "${1:-}" == "--strict" ]]; then
|
|
STRICT=true
|
|
fi
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
|
|
|
|
SRC_DIR="$ROOT_DIR/src/clis"
|
|
DOCS_DIR="$ROOT_DIR/docs/adapters"
|
|
|
|
missing=()
|
|
covered=0
|
|
total=0
|
|
|
|
for adapter_dir in "$SRC_DIR"/*/; do
|
|
adapter_name="$(basename "$adapter_dir")"
|
|
total=$((total + 1))
|
|
|
|
# Check if doc exists in browser/ or desktop/ subdirectories
|
|
if [[ -f "$DOCS_DIR/browser/$adapter_name.md" ]] || \
|
|
[[ -f "$DOCS_DIR/desktop/$adapter_name.md" ]]; then
|
|
covered=$((covered + 1))
|
|
else
|
|
# Handle directory name mismatches (e.g., discord-app -> discord)
|
|
alt_name="${adapter_name%-app}"
|
|
if [[ "$alt_name" != "$adapter_name" ]] && \
|
|
{ [[ -f "$DOCS_DIR/browser/$alt_name.md" ]] || \
|
|
[[ -f "$DOCS_DIR/desktop/$alt_name.md" ]]; }; then
|
|
covered=$((covered + 1))
|
|
else
|
|
missing+=("$adapter_name")
|
|
fi
|
|
fi
|
|
done
|
|
|
|
echo "📊 Doc Coverage: $covered/$total adapters documented"
|
|
echo ""
|
|
|
|
if [[ ${#missing[@]} -gt 0 ]]; then
|
|
echo "⚠️ Missing docs for ${#missing[@]} adapter(s):"
|
|
for name in "${missing[@]}"; do
|
|
echo " - $name → create docs/adapters/browser/$name.md or docs/adapters/desktop/$name.md"
|
|
done
|
|
echo ""
|
|
if $STRICT; then
|
|
echo "❌ Doc check failed (--strict mode)."
|
|
exit 1
|
|
else
|
|
echo "💡 Run with --strict to fail CI on missing docs."
|
|
exit 0
|
|
fi
|
|
else
|
|
echo "✅ All adapters have documentation."
|
|
exit 0
|
|
fi
|