Simplify README and split source docs#15
Conversation
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR restructures the project's documentation and clarifies its development standards. It introduces a new Portuguese documentation file for sources and endpoints, rewrites the README and CONTRIBUTING guide, updates the web interface navigation, and adjusts comments across multiple configuration and script files to reflect the current guardrails approach. ChangesDocumentation & Project Standards
Documentation Portal & Web Interface
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request refactors the project's documentation by moving detailed source and endpoint information from the README to a new dedicated file and a corresponding web page at /sources. The web interface is updated with a new template and improved navigation across the landing, documentation, and labs pages. Feedback identifies opportunities to improve the HTML rendering of technical terms, ensure the copy-to-clipboard functionality handles multiple examples correctly, and maintain footer consistency across all pages.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/SOURCES_AND_ENDPOINTS.md`:
- Around line 64-72: The example uses top-level await which will raise a
SyntaxError in normal Python scripts; wrap the await calls to lookup(...) inside
an async function (e.g., async def main()) and run it with asyncio.run(main())
so the snippet is directly copy-paste runnable; update the block to import
asyncio, move the five await lookup(...) calls into main(), and call
asyncio.run(main()) at the end.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 74a87604-56e6-4d2d-b208-ab43dc13dc9a
📒 Files selected for processing (8)
CHANGELOG.mdCONTRIBUTING.mdREADME.mddocs/SOURCES_AND_ENDPOINTS.mdpyproject.tomlscripts/git/guardrails.shsrc/findata/web/templates/docs.htmltests/test_api.py
1 participant
Summary
README.mdinto an objective project overview, quickstart, docs map, quality gates, and scope note.docs/SOURCES_AND_ENDPOINTS.md./sourcesweb page/route and links source details from the API docs page to the GitHub doc instead.wealthumanand cleans decorative ASCII-style doc titles from the README path.Validation
.venv/bin/ruff format --check src/ tests/ scripts/.venv/bin/ruff check src/ tests/ scripts/.venv/bin/python -m mypy src/findata.venv/bin/python -m pytest tests/ -q(227 passed, 16 deselected)git diff --checkNotes
Summary by CodeRabbit
Documentation
New Features
Tests