Skip to content

Commit b767d4a

Browse files
committed
feat: humanize explainers and improve default visual readability
1 parent b9ea7d6 commit b767d4a

18 files changed

+1496
-1389
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ __pycache__/
33
*.py[cod]
44

55
# Skill local outputs
6+
.out*/
7+
code-explainer-output/
68
code-explainer/.out*/
79
code-explainer/.out-gh/
810
code-explainer/.ci-out/

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Outputs include:
66

77
- Compact entry files by default:
88
- `START_HERE.md`
9-
- `DEEP_DIVE.md`
9+
- `SYSTEM_DEEP_DIVE.md`
1010
- `ONBOARDING.html`
11-
- Detailed artifacts under `_details/`:
11+
- Detailed artifacts under `evidence/`:
1212
- overview/deep markdown docs
1313
- diagrams (`.mmd`, `svg`, `png`)
1414
- metadata reports (`meta/*.json`)

code-explainer/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Builds onboarding-grade repository explainers from local or GitHub sources.
1717

1818
Compact-first output + detailed artifacts:
1919

20-
1. Compact entry files (default): `START_HERE.md`, `DEEP_DIVE.md`, `ONBOARDING.html`.
21-
2. Detailed artifacts under `_details/` in compact layout.
20+
1. Compact entry files (default): `START_HERE.md`, `SYSTEM_DEEP_DIVE.md`, `ONBOARDING.html`.
21+
2. Detailed artifacts under `evidence/` in compact layout.
2222
3. Optional full layout writes docs/diagrams/meta directly under output root.
23-
4. Detailed docs include `overview/OVERVIEW.md` and `deep/*.md`.
23+
4. Detailed docs include `overview/OVERVIEW.md` and `deep/SYSTEM_DEEP_DIVE.md`.
2424
5. Diagrams include `.mmd`, `.svg`, and `.png`.
2525
6. Metadata includes quality, confidence, attribution, verification, and fact-check reports.
2626

code-explainer/references/mode-behavior.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Goal: Maximum fidelity and audit-ready onboarding.
6464

6565
## Output Layout
6666

67-
- `--output-layout compact`: default. Produces a minimal root with `START_HERE.md`, `DEEP_DIVE.md`, `ONBOARDING.html`, and stores full artifacts in `_details/`.
67+
- `--output-layout compact`: default. Produces a minimal root with `START_HERE.md`, `SYSTEM_DEEP_DIVE.md`, `ONBOARDING.html`, and stores full artifacts in `evidence/`.
6868
- `--output-layout full`: writes the full docs/diagrams/meta tree directly under output root.
6969
- If `--output` is omitted:
7070
- Local source: output goes to `<source>/code-explainer-output`.

code-explainer/references/output-contract.md

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,42 @@
1010
Written under `<output>/`:
1111

1212
1. `START_HERE.md`
13-
2. `DEEP_DIVE.md`
13+
2. `SYSTEM_DEEP_DIVE.md`
1414
3. `ONBOARDING.html` (when `--format html|both`)
15-
4. `_details/` containing the full artifact tree listed below
15+
4. `evidence/` containing the full artifact tree listed below
1616

1717
## Full Layout
1818

1919
Written directly under `<output>/`:
2020

2121
1. `overview/OVERVIEW.md` (when `--format markdown|both`)
22-
2. `deep/ARCHITECTURE_DEEP.md` (when `--format markdown|both`)
23-
3. `deep/MODULES_DEEP.md` (when `--format markdown|both`)
24-
4. `deep/FLOWS_DEEP.md` (when `--format markdown|both`)
25-
5. `deep/DEPENDENCIES_DEEP.md` (when `--format markdown|both`)
26-
6. `deep/GLOSSARY.md` (when `--format markdown|both`)
27-
7. `html/ONBOARDING.html` (when `--format html|both`)
28-
8. `diagrams/*.mmd`
29-
9. `diagrams/svg/*.svg`
30-
10. `diagrams/png/*.png`
31-
11. `meta/analysis_manifest.json`
32-
12. `meta/confidence_report.json`
33-
13. `meta/source_attribution.json`
34-
14. `meta/index.json`
35-
15. `meta/stack.json`
36-
16. `meta/entrypoints.json`
37-
17. `meta/dependencies.json`
38-
18. `meta/flows.json`
39-
19. `meta/diagram_manifest.json`
40-
20. `meta/mermaid_validation.json`
41-
21. `meta/render_report.json`
42-
22. `meta/enrichment.json`
43-
23. `meta/coverage_report.json`
44-
24. `meta/explainer_context.json`
45-
25. `meta/verification_checkpoint.json`
46-
26. `meta/llm_summary.json`
47-
27. `meta/docs_generation.json`
48-
28. `meta/html_generation.json` (when `--format html|both`)
49-
29. `meta/fact_check_report.json`
50-
30. `meta/content_completeness.json`
51-
31. `meta/quality_report.json`
52-
32. `meta/compact_output.json` (when `--output-layout compact`)
22+
2. `deep/SYSTEM_DEEP_DIVE.md` (when `--format markdown|both`)
23+
3. `html/ONBOARDING.html` (when `--format html|both`)
24+
4. `diagrams/*.mmd`
25+
5. `diagrams/svg/*.svg`
26+
6. `diagrams/png/*.png`
27+
7. `meta/analysis_manifest.json`
28+
8. `meta/confidence_report.json`
29+
9. `meta/source_attribution.json`
30+
10. `meta/index.json`
31+
11. `meta/stack.json`
32+
12. `meta/entrypoints.json`
33+
13. `meta/dependencies.json`
34+
14. `meta/flows.json`
35+
15. `meta/diagram_manifest.json`
36+
16. `meta/mermaid_validation.json`
37+
17. `meta/render_report.json`
38+
18. `meta/enrichment.json`
39+
19. `meta/coverage_report.json`
40+
20. `meta/explainer_context.json`
41+
21. `meta/verification_checkpoint.json`
42+
22. `meta/llm_summary.json`
43+
23. `meta/docs_generation.json`
44+
24. `meta/html_generation.json` (when `--format html|both`)
45+
25. `meta/fact_check_report.json`
46+
26. `meta/content_completeness.json`
47+
27. `meta/quality_report.json`
48+
28. `meta/compact_output.json` (when `--output-layout compact`)
5349

5450
## Manifest Schema
5551

code-explainer/scripts/analyze.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -196,20 +196,20 @@ def run_pipeline(
196196
output_layout = (output_layout or "compact").strip().lower()
197197
if output_layout not in {"compact", "full"}:
198198
output_layout = "compact"
199-
artifact_root = output_root if output_layout == "full" else output_root / "_details"
199+
artifact_root = output_root if output_layout == "full" else output_root / "evidence"
200200

201201
if output_layout == "compact":
202202
_clear_generated_paths(
203203
output_root,
204204
[
205-
"_details",
205+
"evidence",
206206
"meta",
207207
"overview",
208208
"deep",
209209
"diagrams",
210210
"html",
211211
"START_HERE.md",
212-
"DEEP_DIVE.md",
212+
"SYSTEM_DEEP_DIVE.md",
213213
"ONBOARDING.html",
214214
],
215215
)
@@ -242,7 +242,7 @@ def run_pipeline(
242242
stack_payload = detect_stack.analyze_stack(repo_root, index_payload, meta_dir)
243243
entry_payload = map_entrypoints.map_entrypoints(index_payload, repo_root, meta_dir)
244244
dep_payload = map_dependencies.map_dependencies(repo_root, index_payload, meta_dir)
245-
flow_payload = map_flows.map_flows(stack_payload, entry_payload, dep_payload, meta_dir, mode)
245+
flow_payload = map_flows.map_flows(repo_root, stack_payload, entry_payload, dep_payload, meta_dir, mode)
246246
coverage_payload = ingest_docs.ingest_docs(repo_root, index_payload, meta_dir, mode)
247247
context_payload = explainer_context.build_explainer_context(
248248
repo_root=repo_root,

0 commit comments

Comments
 (0)