Skip to content

Updated the readme.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Banyango merged 1 commit into from
Jul 27, 2025
Merged

Updated the readme.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ python main.py repos ls
## Project Structure
```
src
├── app # CLI (Textual, Click, etc.)
├── app # CLI (Click)
Copy link

Copilot AI Jul 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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)

Copilot uses AI. Check for mistakes.
│ ├── repos
│ │ ├── repo.py # CLI subcommands & DuckDB client
│ │ ├── repos.py
Expand All @@ -48,15 +48,14 @@ src
│ ├── embeddings
│ ├── config.py
│ ├── container.py
├── core # Business logic
│ ├── repos
│ │ ├── add_repo_operation.py
│ │ ├── errors.py
├── data # Pure queries/statements
├── core # Business logic (operations & queries)
Copy link

Copilot AI Jul 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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

Copilot uses AI. Check for mistakes.
│ ├── commits
│ │ ├── operations/
│ │ ├── queries/
│ ├── repos
│ │ ├── queries.py
│ │ ├── statements.py
│ │ ├── operations/
│ │ ├── queries/
│ │ ├── errors.py
├── entities # Inner-level entities/models
│ ├── base.py
│ ├── commits.py
Expand All @@ -82,8 +81,5 @@ MIT
## Acknowledgements
- [DuckDB](https://duckdb.org/)
- [ChromaDB](https://www.trychroma.com/)
- [Textual](https://textual.textualize.io/)

---

*OrangeJuice: Squeeze the most out of your git.*