Skip to content

docs(v2): update in-repo docs to the services/features layout#269

Merged
NitinKumar004 merged 2 commits into
developmentfrom
docs/v2-inrepo-paths
Jul 12, 2026
Merged

docs(v2): update in-repo docs to the services/features layout#269
NitinKumar004 merged 2 commits into
developmentfrom
docs/v2-inrepo-paths

Conversation

@NitinKumar004

Copy link
Copy Markdown
Collaborator

Follow-up to the v2 restructure (#268): the in-repo docs/*.md still had prose/tree references to the old flat layout. Updates the architecture directory tree and bare-path references (storage/driverservices/storage/driver, topology/features/topology/, etc.) in architecture.md, services.md, features.md. Docs-only; build green.

The v2 restructure moved service packages under services/ and cross-cutting
ones under features/. Update the architecture directory tree and the prose
path references (e.g. storage/driver -> services/storage/driver, topology/ ->
features/topology/) in architecture.md, services.md, and features.md.
architecture.md prose (storage/, compute/, database/) and services.md
kubernetes/ references now point at services/<name>/.
@NitinKumar004

Copy link
Copy Markdown
Collaborator Author

/review — docs(v2) in-repo path refs

Scope: docs-only (architecture.md, services.md, features.md). No code touched; build green.

Angles run: removed-behavior (did any path rewrite point at a package that doesn't exist?), cross-file (do the new services/*/features/* paths match the actual on-disk layout after #268?), completeness (did the sweep miss any stale prose refs?).

Findings

# Severity Location Finding Status
1 Low architecture.md:36, services.md:26/1042/1078 Bare service-package refs (storage/, compute/, database/, kubernetes/) not caught by the /driver-anchored sweep — still pointed at the old flat layout ✅ Fixed (2nd commit)
  • Verified every rewritten path resolves to a real package on development post-refactor(v2)!: restructure repo into services/ + features/, bump module to /v2 #268: services/<name>/driver/driver.go and features/{topology,recorder,metrics,ratelimit,inject,chaos}/ all exist.
  • No dead internal links introduced; [topology.md] / [sdk-server.md] targets unchanged.
  • Final sweep after fix: zero stale bare-path or non-/v2 refs across all docs/*.md.

Nothing else surfaced. Ready to merge once approved.

@NitinKumar004 NitinKumar004 merged commit cabe2d2 into development Jul 12, 2026
9 checks passed
@NitinKumar004 NitinKumar004 deleted the docs/v2-inrepo-paths branch July 12, 2026 06:20
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