Skip to content

TASK-C07: Editorial Polish and Cross-Linking

  • Status: Ready
  • Scope Type: Editorial integration
  • Recommended Model Tier: Budget to Balanced
  • Recommended Reasoning: Low to Medium

Objective

Perform the final polish pass so the course reads like one coherent training system instead of several unrelated markdown additions.

Scope

  • unify titles and intros
  • align page structure
  • add related-reading links
  • add newcomer-friendly cross-links to lessons, scenarios, architecture pages, and reference docs
  • add a light glossary or quick-reference index only if the course now needs it

Non-Scope

  • rewriting the entire content set from scratch
  • adding large new modules
  • changing product behavior

Files To Read First

  • all new files under docs/course
  • all new files under docs/scenarios
  • all new files under docs/architecture
  • docs/index.md
  • docs/.vitepress/config.mts

Verification

  • the course feels consistent in voice and structure
  • links are coherent
  • VitePress build passes

Copy/Paste Prompt

text
You are working in C:\Lcn.Workspaces\lcn-wafer-inspection-desktop.

Audience: a newcomer software engineer or automation engineer learning this project.
Goal: turn this repo into a high-quality engineering training course, not just reference docs.
Style: practical, detailed, blog-quality English; clear headings; concrete examples; no fluff.
Ground all claims in the repo docs and code. Do not invent behavior that the current project does not support.
Prefer reusing and linking existing content under docs/lessons, docs/specs, docs/tasks, docs/adrs, docs/implementation, and the source code when helpful.
For diagrams, do not generate binary assets. Instead, produce a Draw.io-friendly diagram brief: title, purpose, nodes, edges, grouping, caption, and destination file path.
If you edit docs, keep VitePress navigation coherent and make sure npm run docs:build passes.

Task: Perform an editorial polish pass across the new training materials.

Do:
- unify titles, intros, and section structure
- add related-reading links between course pages, scenarios, architecture pages, lessons, and reference docs
- add a small glossary or quick-reference index only if needed
- keep the material repo-centered and practical

Do not:
- bloat pages with generic textbook content
- rewrite stable pages unless the change improves cohesion

Verify:
- navigation is coherent
- the pages feel like one course
- npm run docs:build passes

Docs-first project memory for AI-assisted implementation.