Skip to content

docs(readme): quickstart shows readable output, then the checks - #124

Merged
FROWNINGdev merged 1 commit into
mainfrom
docs/quickstart-readable-output
Sep 27, 2026
Merged

FROWNINGdev merged 1 commit into
mainfrom
docs/quickstart-readable-output

Conversation

@FROWNINGdev

Copy link
Copy Markdown
Owner

uvx django-orm-lens scan — the first command in the README and in every launch post — prints the full JSON index (≈200 lines for five models). The quickstart now uses scan -f table for the overview, followed by nplusone and migration-risk, where a newcomer actually sees a finding. EN + ru/es/zh.

The first command the README hands a newcomer, 'uvx django-orm-lens scan',
prints the full JSON index: about 200 lines for a five-model project, not
the first insight the section promises. The quickstart now runs 'scan -f
table' for an overview, then nplusone and migration-risk, which is where
the tool finds something worth acting on. Same change in ru/es/zh.
@coderabbitai

coderabbitai Bot commented Sep 27, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 46 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: ea491626-1a44-4dc1-8a8e-03d69ff51225

📥 Commits

Reviewing files that changed from the base of the PR and between 8b494bd and 6699da3.

📒 Files selected for processing (4)
  • README.md
  • docs/i18n/README.es.md
  • docs/i18n/README.ru.md
  • docs/i18n/README.zh.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@FROWNINGdev
FROWNINGdev merged commit 610d574 into main Sep 27, 2026
18 of 19 checks passed
@FROWNINGdev
FROWNINGdev deleted the docs/quickstart-readable-output branch September 27, 2026 21:28
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