Updated the readme.md#4
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md file to reflect recent changes in project structure and dependencies. The updates simplify and reorganize the documented project architecture.
- Removed references to Textual framework and consolidated CLI description to only mention Click
- Restructured the core directory documentation to show operations/ and queries/ subdirectories
- Removed Textual from acknowledgements and the project tagline
| ``` | ||
| src | ||
| ├── app # CLI (Textual, Click, etc.) | ||
| ├── app # CLI (Click) |
There was a problem hiding this comment.
[nitpick] The comment should clarify what Click is for readers unfamiliar with the framework. Consider: '# CLI framework (Click)'
Suggested change
| ├── app # CLI (Click) | |
| ├── app # CLI framework (Click) |
| │ │ ├── add_repo_operation.py | ||
| │ │ ├── errors.py | ||
| ├── data # Pure queries/statements | ||
| ├── core # Business logic (operations & queries) |
There was a problem hiding this comment.
[nitpick] The parenthetical explanation '(operations & queries)' is redundant since the subdirectories below already show 'operations/' and 'queries/' folders. Consider simplifying to just '# Business logic'
Suggested change
| ├── core # Business logic (operations & queries) | |
| ├── core # Business logic |
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
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.
No description provided.