mirror of
https://github.com/NVIDIA/OpenShell.git
synced 2026-10-03 16:11:17 +08:00
Johnny Greco
87929ad130
* docs: align page file names and nav labels with published URLs Signed-off-by: Johnny Greco <jogreco@nvidia.com> * docs: redirect moved dev pages and fix agent guide redirects Signed-off-by: Johnny Greco <jogreco@nvidia.com> * ci(docs): check that page URLs match their file paths Signed-off-by: Johnny Greco <jogreco@nvidia.com> * fix(docs): align navigation checks with repo conventions Signed-off-by: Johnny Greco <jogreco@nvidia.com> * docs: omit historical redirect aliases Signed-off-by: Johnny Greco <jogreco@nvidia.com> * fix(docs): preserve published overview and TypeScript URLs Signed-off-by: Johnny Greco <jogreco@nvidia.com> * fix(docs): redirect unversioned overview and TypeScript URLs Signed-off-by: Johnny Greco <jogreco@nvidia.com> --------- Signed-off-by: Johnny Greco <jogreco@nvidia.com>
42 lines
1.1 KiB
TOML
42 lines
1.1 KiB
TOML
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
# Documentation build, serve, and check tasks
|
|
|
|
["docs"]
|
|
description = "Validate Fern documentation"
|
|
depends = ["docs:build:strict", "docs:nav"]
|
|
|
|
["docs:deps"]
|
|
description = "Resolve Fern CLI for docs tasks"
|
|
run = """
|
|
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
|
|
npx --yes "fern-api@${FERN_VERSION}" --version
|
|
"""
|
|
|
|
["docs:build:strict"]
|
|
description = "Validate docs config and links"
|
|
depends = ["docs:deps"]
|
|
run = """
|
|
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
|
|
cd fern
|
|
npx --yes "fern-api@${FERN_VERSION}" check
|
|
"""
|
|
|
|
["docs:nav"]
|
|
description = "Check that docs page URLs match their file paths"
|
|
run = "uv run tasks/scripts/check_docs_nav.py"
|
|
|
|
["docs:serve"]
|
|
description = "Serve Fern docs locally"
|
|
depends = ["docs:deps"]
|
|
run = """
|
|
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
|
|
cd fern
|
|
npx --yes "fern-api@${FERN_VERSION}" docs dev
|
|
"""
|
|
|
|
["docs:clean"]
|
|
description = "Remove local Fern docs cache"
|
|
run = "rm -rf .fern-cache fern/.fern-cache"
|