跳到主要内容

next-docs Repo Architecture

next-docs Repo Architecture

tiangong-lca-next-docs owns the public TianGong LCA documentation site built with Docusaurus.

Owned Surfaces

  • docs/** is the canonical Chinese public-doc source.
  • i18n/en/docusaurus-plugin-content-docs/current/** is the maintained English mirror and should change with its paired Chinese page.
  • sidebars.ts, docusaurus.config.ts, src/**, and static/** define site structure, presentation, screenshots, and custom site behavior.
  • static/llms.txt, context7.json, .github/workflows/publish-docs.yml, and scripts/*llms* / scripts/*publication* define the public AI-consumption and post-merge publication boundary.
  • TODO.docs-system-gaps.md is the durable backlog for product/docs drift.

Non-Owner Boundaries

  • tiangong-lca-next owns shipped product behavior, route truth, API semantics, and UI control behavior.
  • lca-workspace owns root integration state and submodule pointer updates.

Do not document product behavior here without checking the product repository when the current behavior is ambiguous.

Integration Semantics

A merged PR in this repository is repo-complete only. If the updated docs site snapshot must ship through the workspace, root integration must deliberately update the tiangong-lca-next-docs submodule pointer after merge.

Local Docpact Push Gate

This repository has a versioned local pre-push hook under .githooks/pre-push that delegates to scripts/docpact-gate.sh. The gate resolves the CLI through scripts/docpact, so local agent shells do not need bare docpact on PATH. The hook is a local developer guard for docpact config validation and enforced doc-governance linting; ordinary PRs and pushes rely on the local gate; .github/workflows/ai-doc-lint.yml is manual-dispatch fallback for remote reproduction.