Developers

Developing TraDoc

Guideposts for changing the engine, API, interface or documentation.

TraDoc combines Python and JavaScript in one product repository. The root contains the backend, parsers and CLI; web/ is an independent Vite project.

Before a change

  1. Create a focused branch.
  2. Reproduce the current behavior.
  3. Identify the relevant parser and reconstruction path.
  4. Add a regression test.
  5. Validate backend, frontend and exports.

Central rule

A visual or architectural improvement must not silently remove a feature: import, provider, model, glossary, preset, tracking, pause, resume, test, export and settings must remain accessible.