Skip to content

Add README + cross-references for every workspace/ subfolder - #7

Open
coding-jona wants to merge 1 commit into
mainfrom
dev
Open

Add README + cross-references for every workspace/ subfolder#7
coding-jona wants to merge 1 commit into
mainfrom
dev

Conversation

@coding-jona

Copy link
Copy Markdown
Owner

Applies the same documentation treatment already done for src/tarno_backend/ to workspace/, which previously had zero README files despite being a peer-level restructuring effort earlier this session.

  • New: workspace_README.md, debug/debug_README.md, debug/docs/docs_README.md, debug/docs/adr/adr_README.md, debug/tests/tests_README.md, debug/tools/tools_README.md, debug/installer/installer_README.md, plans/plans_README.md, scripts/scripts_README.md, future/future_README.md - 45 cross-references between them, verified resolvable with a small link-checker script.
  • installer_README.md documents the real gap: release_installer.yml references a pipeline/tests/scripts structure that was never built out - flagged explicitly rather than silently left confusing.
  • adr_README.md indexes all 6 ADRs and documents the ADR-004 numbering collision fixed earlier, so it doesn't happen again.
  • Fixed stale pre-rename tarno/... path references in workspace/debug/tools/*.py docstrings (debug_coding_agent.py, debug_proactive_live.py, debug_proactive_voice.py, mesh_mock_sender.py) to tarno_backend/... - missed by the original rename pass since it only touched src/ and workspace/debug/tests/.

Applies the same documentation treatment already done for
src/tarno_backend/ to workspace/, which previously had zero README
files despite being a peer-level restructuring effort earlier this
session.

- New: workspace_README.md, debug/debug_README.md,
  debug/docs/docs_README.md, debug/docs/adr/adr_README.md,
  debug/tests/tests_README.md, debug/tools/tools_README.md,
  debug/installer/installer_README.md, plans/plans_README.md,
  scripts/scripts_README.md, future/future_README.md - 45
  cross-references between them, verified resolvable with a small
  link-checker script.
- installer_README.md documents the real gap: release_installer.yml
  references a pipeline/tests/scripts structure that was never built
  out - flagged explicitly rather than silently left confusing.
- adr_README.md indexes all 6 ADRs and documents the ADR-004 numbering
  collision fixed earlier, so it doesn't happen again.
- Fixed stale pre-rename `tarno/...` path references in
  workspace/debug/tools/*.py docstrings (debug_coding_agent.py,
  debug_proactive_live.py, debug_proactive_voice.py,
  mesh_mock_sender.py) to tarno_backend/... - missed by the original
  rename pass since it only touched src/ and workspace/debug/tests/.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@coding-jona coding-jona mentioned this pull request Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant