mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-03-24 02:24:09 +08:00
85aa863c56
Add conditional metadata generation for PRs that modify both docs and source files. This fixes broken link checker reports when a PR adds a new module and documents it simultaneously - previously the link checker would fail because metadata files are only generated on push to main. Changes: - Add docs-orchestrator.yml workflow with: - detect-changes job to check if PR touches source paths - pr-metadata-regen job that generates metadata and uploads as artifact - link-check job that downloads metadata artifact when available - build-site job for VitePress site generation - deploy-aws and crowdin-upload jobs for push events - Prettier formatting step before auto-commit on push - Add Prettier for markdown formatting: - Add prettier ^3.2.0 as devDependency in docs/package.json - Add docs/.prettierrc with prose-preserving config - Remove normalize_whitespace from metadata_sync.sh (Prettier handles whitespace normalization now) Signed-off-by: Ramon Roche <mrpollo@gmail.com>
31 lines
1.1 KiB
JSON
31 lines
1.1 KiB
JSON
{
|
|
"name": "px4_user_guide",
|
|
"version": "1.0.1",
|
|
"repository": "https://github.com/PX4/px4_user_guide.git",
|
|
"license": "CC-BY-4.0",
|
|
"scripts": {
|
|
"docs:dev": "vitepress dev .",
|
|
"docs:build": "yarn docs:build_ubuntu",
|
|
"docs:buildwin": "set NODE_OPTIONS=--max_old_space_size=8192 && set CI=true && vitepress build .",
|
|
"docs:build_ubuntu": "NODE_OPTIONS='--max-old-space-size=8192' vitepress build .",
|
|
"docs:preview": "vitepress preview .",
|
|
"docs:sitemap": "python3 ./scripts/gen_sitemap.py",
|
|
"docs:gen_alt_sidebar_ubuntu": "python3 ./scripts/gen_alt_sidebar.py",
|
|
"docs:get_alt_sidebar_windows": "python ./scripts/gen_alt_sidebar.py",
|
|
"start": "yarn docs:dev",
|
|
"linkcheck": "markdown_link_checker_sc -r .. -d docs -e en -i assets"
|
|
},
|
|
"dependencies": {
|
|
"@red-asuka/vitepress-plugin-tabs": "0.0.4",
|
|
"lite-youtube-embed": "^0.3.3",
|
|
"markdown-it-mathjax3": "^4.3.2",
|
|
"medium-zoom": "^1.1.0",
|
|
"open-editor": "^5.0.0",
|
|
"vitepress": "^1.6.3",
|
|
"vue3-tabs-component": "^1.3.7"
|
|
},
|
|
"devDependencies": {
|
|
"prettier": "^3.2.0"
|
|
}
|
|
}
|