Conversation
New contributors and agents had to read source to learn what each directory does. Several upstream docs are also stale, so folder-level guides provide a verifiable entry point next to the code they describe. Add a README to each significant directory covering its purpose, the conventions to follow and the traps to avoid, plus docs/ as the committed home for fork-local documentation. Highlights: - src/ and src-tauri/src/: the dictation spine, and the settingUpdaters trap where a missing entry silently desyncs UI state from Rust - src-tauri/: Cargo patch rationale and the packaging-identity checklist - tests/: states that Playwright runs without Tauri IPC and cannot verify app behaviour - scripts/: documents the maintainer-only catalog tooling transcribe-libs/ is described as the generated, gitignored build output it is rather than as checked-in binaries. Generated and vendored directories are deliberately left undocumented.
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.
New contributors and agents had to read source to learn what each directory does. Several upstream docs are also stale, so folder-level guides provide a verifiable entry point next to the code they describe.
Add a README to each significant directory covering its purpose, the conventions to follow and the traps to avoid, plus docs/ as the committed home for fork-local documentation.
Highlights:
transcribe-libs/ is described as the generated, gitignored build output it is rather than as checked-in binaries.
Generated and vendored directories are deliberately left undocumented.
Before Submitting This PR
Please submit only one fix or feature per pull request. Pull requests containing multiple fixes or features will likely be closed.
Please confirm you have done the following:
If this is a feature or change that was previously closed/rejected:
Human Written Description
Related Issues/Discussions
Fixes #
Discussion:
Community Feedback
Testing
Screenshots/Videos (if applicable)
AI Assistance
If AI was used: