Skip to content

Commit 9a51751

Browse files
authored
docs: add CodeRabbit review prompts for documentation (#1294)
Signed-off-by: Mounil <mounilkankhara@gmail.com>
1 parent be1ac2f commit 9a51751

File tree

2 files changed

+67
-1
lines changed

2 files changed

+67
-1
lines changed

.coderabbit.yaml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,71 @@ reviews:
168168
- When tests fail in CI, developers should immediately understand what broke.
169169
- Redundant setup code should be refactored, but clarity trumps abstraction.
170170
171+
# --- DOCUMENTATION REVIEW INSTRUCTIONS ---
172+
- path: "docs/**"
173+
instructions: |
174+
You are reviewing documentation for the Hiero Python SDK. These pages serve both SDK users and SDK developers.
175+
176+
Priority 1 - Correctness (code, commands, links)
177+
1. Verify code snippets conceptually run and match the current SDK API.
178+
2. Check shell commands and workflow steps against actual project tooling.
179+
3. Validate URLs and cross-references; flag broken or misleading links.
180+
181+
Priority 2 - Clarity and completeness
182+
1. Ensure each page states its purpose and expected outcome early.
183+
2. Prefer concrete, step-wise explanations over vague descriptions.
184+
3. Highlight missing prerequisites that would block a reader.
185+
4. For larger gaps, suggest filing a follow-up issue instead of blocking.
186+
187+
Priority 3 - Consistency and navigation
188+
1. Encourage consistent terminology with the SDK and examples.
189+
2. Check headings form a logical reading path.
190+
3. Confirm each page makes clear which audience it serves.
191+
192+
PHILOSOPHY
193+
- Treat docs as work-in-progress: optimize for correctness and clarity over perfection.
194+
- Keep feedback concise, action-oriented, and focused on reader success.
195+
- Do not request large-scale restructures unless current structure blocks understanding.
196+
197+
AVOID
198+
- Avoid lint-style feedback on Markdown formatting or minor wording.
199+
- Avoid proposing new conventions without clear benefit.
200+
- Avoid turning every high-level gap into a blocker.
201+
202+
- path: "docs/sdk_users/**"
203+
instructions: |
204+
These documents are for SDK users who want to USE the Hiero Python SDK quickly and correctly.
205+
206+
Priority 1 - High-level guidance
207+
1. Ensure explanations are conceptual and point to `/examples` for runnable code.
208+
2. Check that required environment variables and network choices are clearly stated.
209+
210+
Priority 2 - No hidden assumptions
211+
1. Assume zero prior knowledge of this SDK and minimal Hedera background.
212+
2. Avoid requiring knowledge of repository layout or contribution workflow.
213+
214+
PHILOSOPHY
215+
- Keep explanations high-level and conceptual; defer runnable examples to `/examples`.
216+
- Focus on what users need to know before diving into code examples.
217+
218+
- path: "docs/sdk_developers/**"
219+
instructions: |
220+
These documents are for SDK developers and contributors, including `docs/sdk_developers/training/**`.
221+
222+
Priority 1 - Workflow accuracy
223+
1. Ensure contribution, branching, rebasing, signing (DCO, GPG), CI, linting, and testing instructions match the repo.
224+
2. Verify `git` and GitHub flows agree with CONTRIBUTING.md and current practice.
225+
3. Flag outdated references to scripts, directories, or configuration files.
226+
227+
Priority 2 - Training flow
228+
1. For training docs, ensure logical progression and clear prerequisites.
229+
2. Check that cross-links between training files are coherent.
230+
231+
PHILOSOPHY
232+
- Treat these docs as a training ground for future maintainers and regular contributors.
233+
- Help readers move from "I cloned the repo" to "I can safely extend and debug the SDK".
234+
- Balance approachability for beginners with enough depth for experts.
235+
171236
# --- CUSTOM INSTRUCTIONS FOR .GITHUB DIRECTORY ---
172237
- path: ".github/workflows/**/*"
173238
instructions: |

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Changelog
1+
# Changelog
22

33
All notable changes to this project will be documented in this file.
44
This project adheres to [Semantic Versioning](https://semver.org).
@@ -125,6 +125,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
125125
- Updated `transfer_transaction_hbar.py` example to use `Hbar` objects instead of raw integers and added receipt checking with `ResponseCode` validation.([#1249](https://github.com/hiero-ledger/hiero-sdk-python/issues/1249))
126126
- Renamed `pr-missing-linked-issue.yml` and `pr_missing_linked_issue.js` to `bot-pr-missing-linked-issue.yml` and `bot-pr-missing-linked-issue.js` respectively. Enhanced LinkBot PR comment with clickable hyperlinks to documentation for linking issues and creating issues. (#1264)
127127
- Enhance assignment bot to guard against users with spam PRs `.github/scripts/bot-assignment-check.sh`
128+
- Add CodeRabbit documentation review prompts for docs, sdk_users, and sdk_developers with priorities, philosophy, and edge case checks. ([#1236](https://github.com/hiero-ledger/hiero-sdk-python/issues/1236))
128129

129130
### Fixed
130131
- GFI workflow casing

0 commit comments

Comments
 (0)