Repository Architecture

Document areas

Location	Purpose
Business and product planning	Business plan, product plan, market and commercial models, compliance, assumptions, and open questions
Product package	One directory per product line, containing target specifications and design appendices; shared/ contains the CAN protocol and configuration schema
Research	Reports, supplier catalogs, and the data/ and sources/ evidence archives
Project tracking	Task and plan records, changelog, and repository guidance; decisions/ is created when a local deviation needs recording
s7-200g2/	Vendor reference PDFs retained in the repository and excluded from the website

Documents under bizplan/ are Chinese except BUSINESS-PLAN.en.md. Project records under docs/ are English. Shared business-plan claims, figures, gates, and schedules must stay aligned between the Chinese and English versions.

Navigation and document authority

Readers enter through the home page and directory index.md pages. The product package index links to product directories; each product directory maintains its own document inventory. The Air/Key overview similarly links to category indexes, where supplier inventories and cross-category references are maintained.

PRODUCT-PLAN.md governs product tiers, prices, milestones, and unresolved engineering decisions. Product specifications define target requirements; design appendices must not change their Level-1 values. Research indexes distinguish selected directions, proposals, supporting evidence, and superseded alternatives. Research proposals do not revise controlled specifications until adopted through the project workflow.

Add a directory index.md whenever a new page-bearing directory is introduced so it has a reachable entry point and breadcrumb label. Use relative Markdown links for document references, resolved from the containing file. Retired task and plan IDs may point to their surviving changelog entries.

Site and publication

VitePress renders Markdown in place with clean URLs, such as /bizplan/product/core/P01-core. There are no locale route rewrites or sidebar. The English business plan is served at /bizplan/BUSINESS-PLAN.en.

• .vitepress/config.mts defines navigation, Chinese local search, the directory breadcrumb map, and asset copying.
• .vitepress/theme/index.ts and Breadcrumb.vue render the breadcrumb above page content. Directory labels come from index frontmatter titles or H1 headings.
• bun run docs:dev serves the site locally; bun run docs:build writes .vitepress/dist/.
• Non-Markdown files under bizplan/ are copied at their source paths, except individual files larger than 25 MiB. The Bertram 43 and Bertram 700 original manuals remain repository-only archives; the source catalog identifies their publisher downloads.
• s7-200g2/, bsp-control/, tmp/, and the root instruction files are excluded from rendered pages.
• .github/workflows/deploy.yml builds and deploys Cloudflare Workers static assets only when manually dispatched; wrangler.jsonc identifies the output directory and 404 behavior.

Verification

Run bun run docs:build and git diff --check. Also check rendered internal links, fragment IDs, and downloadable assets: a successful build alone does not validate every fragment or ensure oversized source assets were published. Keep task/plan index markers consistent with their detail records.