Add developer docs section #79
Conversation
WalkthroughA new developer overview page was added to the documentation, introducing the project structure and guidance for contributors. The main documentation index was updated with a hidden table of contents section linking to this new developer guide. No changes were made to code or public interfaces. Changes
Poem
✨ Finishing Touches🧪 Generate Unit Tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
the
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/source/index.rst (1)
36-43: Consider making the Developer Guide entry visibleThe
:hidden:option will hide this toctree on the homepage, which may prevent new contributors from noticing the Developer Guide link. If your goal is to surface it directly for easier access, remove the:hidden:flag.docs/source/developer/index.rst (2)
6-19: Nitpick: hyphenate "high level" and refine wordingUse "high-level overview" for clarity and consistency:
- This section provides a high level look at the ``hckr`` project for new contributors. + This section provides a high-level overview of the ``hckr`` project for new contributors.
20-26: Nitpick: hyphenate "top-level"To maintain consistency, hyphenate "top level":
- Each subcommand (...) is defined in its own module within ``src/hckr/cli`` and added to the top level ``cli`` group. + Each subcommand (...) is defined in its own module within ``src/hckr/cli`` and added to the top-level ``cli`` group.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (2)
docs/source/developer/index.rst(1 hunks)docs/source/index.rst(1 hunks)
🔇 Additional comments (2)
docs/source/developer/index.rst (2)
1-4: Anchor and title formatting are correctThe section anchor and RST title adhere to Sphinx conventions and will render properly.
27-35: Next Steps section is clearThe action items are concise and well-scoped for new contributors to get started.
Summary
Testing
pip install -q rich click click-repl croniter cron-descriptor cryptography Faker pandas openpyxl xlrd pyarrow fastavro sqlacodegen yaspin speedtest-cli kubernetes sqlalchemypip install -q requests packaging psycopg2-binary pymysql snowflake-sqlalchemy sentry-sdkPYTHONPATH=$PWD/src pytest -q(fails: HTTP Error 403 from speedtest.net)https://chatgpt.com/codex/tasks/task_e_685049413ae88327bec6af64b3ab7245
Summary by CodeRabbit