[00134] Document and Assess the Repository Folder Structure - #130
Merged
rorychatt merged 2 commits intoAug 10, 2026
Merged
Conversation
Adds docs/repository-structure.md covering the top-level tree, the src/frontend .NET-scaffold inheritance, the two e2e trees, the widget ownership map, and known structural debt including the undecided src/frontend backend question. Fixes README.md's crate table (3 missing crates), rewrites src/frontend/README.md's Development section to match the pnpm workflow CI actually uses, corrects stale .gitattributes/.gitignore comments and entries, and documents the dead src/frontend/e2e suite. Plan: 00134
…eview Reviewer feedback said the new structure doc is unneeded. Drop it along with src/frontend/e2e/README.md (the other markdown this plan added) and the README.md section linking to the removed doc. The crate-table fix, .gitattributes/.gitignore corrections, and src/frontend/README.md rewrite stay, since those fix existing files rather than add new documentation. Plan: 00134
rorychatt
deleted the
tendril/00134-DocumentAndAssessTheRepositoryFolderStructure
branch
August 10, 2026 09:24
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Added
docs/repository-structure.mddocumenting the repo's top-level tree, why Rust crates sitat the root while
src/holds only the frontend, the two conflictinge2etrees, the four-placewidget ownership map, and known structural debt (including the undecided fate of
src/frontend's.NET-era backend dependency). Fixed six pieces of stale/inconsistent metadata that fell out of
writing the doc down:
README.md's crate table,src/frontend/README.md's inherited .NET setupinstructions,
.gitattributes'/.gitignore's stale comments and phantom entries, and a newsrc/frontend/e2e/README.mddocumenting that suite's dead status.API Changes
None. All changes are documentation,
.gitattributes/.gitignorecomments, and a.gitignoreentry cleanup — no code, config schema, or CI behavior changed.
Files Modified
docs/repository-structure.md(new) — repository layout docREADME.md— new "Repository Layout" section; crate table gainedrusty-filter,rusty-docs,rusty-desktopsrc/frontend/README.md— Development section rewritten to match the actual pnpm/Vite+ workflowsrc/frontend/e2e/README.md(new) — documents the suite as dead/unwired.gitattributes— corrected stale root-.huskyclaim.gitignore— replaced four phantom per-cratetarget/entries with the existing shared/targetManual Testing
N/A — internal documentation and metadata change with no user-facing or build-behavior effect.
Fix: Remove extra markdown files per review feedback
Reviewer feedback said
docs/repository-structure.mdwas unneeded. Removed it, plussrc/frontend/e2e/README.md(the other net-new markdown file this plan added), plus theREADME.md"Repository Layout" section that linked to the removed doc. The metadata fixes(crate table,
.gitattributes,.gitignore,src/frontend/README.md's Development section)stay, since those correct existing files rather than add new documentation. The "Gate the
structure doc against the tree" recommendation was declined as moot — there is no longer a
structure doc to gate.
Files Modified
docs/repository-structure.md— deletedsrc/frontend/e2e/README.md— deletedREADME.md— "Repository Layout" section removed (crate table addition kept)Commits
Created using Ivy Tendril.