Dogfooding is the agreed first use case. This is a hand-written reference assembled from the
current manifests and source at 9c41fbc, not output generated by CodeTwin. The presentation
below records the original overview and detail proposal. The subsequent workspace slice uses
inspect and visualize; see the generated current overview. The graph below
is historical: the primary crate now also depends directly on codetwin-ir and owns the new CLI,
workspace analysis and Markdown generation. Deeper source views remain a target.
The first workspace-level slice and its test outcomes are specified in the implementation plan.
The first view should answer: where does CodeTwin’s executable behavior live, what does it depend on, and which workspace crates are still scaffolds?
flowchart LR
subgraph product[Current executable dependency chain]
bin[codetwin] --> legacy[codetwin-legacy]
legacy --> model[codetwin-ir]
end
subgraph scaffolds[Workspace crates with intent comments only]
cli[codetwin-cli] -. declared dependency .-> config[codetwin-config]
cli -. declared dependency .-> pipeline[codetwin-pipeline]
pipeline -. declared dependency .-> config
pipeline -. declared dependency .-> drivers[codetwin-drivers]
pipeline -. declared dependency .-> render[codetwin-render]
pipeline -. declared dependency .-> model
drivers -. declared dependency .-> model
render -. declared dependency .-> model
end
subgraph development[Development automation]
xtask[tools/xtask]
end
Arrows point from a dependent crate to its dependency. Dashed arrows belong to scaffold crates outside the current executable’s dependency chain. All arrows describe declared local Cargo dependencies; the grouping additionally reflects the current source implementation. Development automation is a workspace member but is not part of the shipped executable.
| Component | What the developer should learn | Source |
|---|---|---|
codetwin |
Parses arguments, configures tracing and dispatches commands | main.rs |
codetwin-legacy |
Owns today’s CLI, configuration, analysis orchestration and output | lib.rs |
codetwin-ir |
Owns the language-neutral modules, symbols and relationships | model |
| Five scaffold crates | Declare a proposed decomposition but have no implementation yet | workspace index |
tools/xtask |
Checks and scaffolds the repository; does not implement code visualization | entrypoint |
A useful first drill-down follows the gen handler into its directly called code:
flowchart TD
main[main::run] --> dispatch[cli::dispatch]
dispatch --> generate[cli::generate::run]
generate --> config[Config::load_or_default and CLI overrides]
generate --> pipeline[pipeline::run]
pipeline --> discover[pipeline::discover]
pipeline --> select[DriverRegistry: detection or explicit selection]
pipeline --> parse[Driver::parse on selected drivers]
pipeline --> merge[merge::merge_all]
pipeline --> json[JSON model to stdout when requested]
pipeline --> render[pipeline::render and selected Layout::render]
pipeline --> write[write_outputs]
These arrows show static caller relationships and conditional branches, not a runtime trace. JSON model output bypasses rendering and writing. The ordinary path renders and writes. Watch mode wraps repeated execution of the same pipeline.
Source anchors: dispatch, generation, pipeline, discovery, drivers, layouts, writing.
The view should make incomplete behavior visible: drivers currently return empty models; the two primary layouts are placeholders. Unsupported extraction must not look like successful analysis of a repository with no dependencies. Recognizing a TODO is useful evidence; a tool must not infer complete implementation status merely from an empty output.
The first implementation can deliver the workspace inventory before the deeper source view. Fixtures provide precise automated checks; running on CodeTwin provides the real usability check. Optional later CI automation can regenerate and validate the artifacts once generation is meaningful. This document does not add that automation or change the executable.