docs: move Windows setup guide and add missing setup sections#1958
docs: move Windows setup guide and add missing setup sections#1958manishdait merged 2 commits intohiero-ledger:mainfrom
Conversation
… clarity Signed-off-by: Daniel Ntege <danientege785@gmail.com>
… clarity Signed-off-by: Daniel Ntege <danientege785@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (7)
💤 Files with no reviewable changes (1)
WalkthroughThe Windows setup guide was relocated from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📋 Issue PlannerBuilt with CodeRabbit's Coding Plans for faster development and fewer bugs. View plan used: ✨ 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 |
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the Windows developer setup documentation for the Hiero Python SDK by moving the Windows setup guide to a higher-level docs location and updating project references to the new path.
Changes:
- Added a new Windows setup guide at
docs/sdk_developers/setup_windows.mdwith expanded setup, environment, and troubleshooting sections. - Removed the old Windows setup guide at
docs/sdk_developers/training/setup/setup_windows.md. - Updated links in README, CONTRIBUTING, issue templates, and the changelog to reference the new Windows setup guide location.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/sdk_developers/training/setup/setup_windows.md | Removes the outdated Windows setup guide from the training/setup docs tree. |
| docs/sdk_developers/setup_windows.md | Adds the new, expanded Windows setup guide at a more discoverable path. |
| README.md | Updates the Windows setup guide link to the new location. |
| CONTRIBUTING.md | Updates the Windows setup guide link to the new location. |
| CHANGELOG.md | Adds an unreleased entry noting the Windows setup guide move/improvements. |
| .github/ISSUE_TEMPLATE/02_good_first_issue.yml | Updates Windows setup guide reference in the template to the new location. |
| .github/ISSUE_TEMPLATE/01_good_first_issue_candidate.yml | Updates Windows setup guide reference in the template to the new location. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #1958 +/- ##
=======================================
Coverage 93.53% 93.53%
=======================================
Files 141 141
Lines 9146 9146
=======================================
Hits 8555 8555
Misses 591 591 🚀 New features to boost your workflow:
|
aceppaluni
left a comment
There was a problem hiding this comment.
@danielmarv This looks great.
I will make an issue to add information regarding chocolatey.
Thank you!
Description:
This pull request reorganizes and improves the Windows setup documentation for the Hiero Python SDK. The Windows setup guide has been moved to a more logical location, updated for clarity and completeness, and all references throughout the project have been updated accordingly. This ensures new contributors and users can find and follow the correct setup instructions for Windows environments.
Documentation reorganization and improvements:
docs/sdk_developers/setup_windows.mdguide for Windows setup, including prerequisites, dependency management, environment setup, troubleshooting, and optional dependencies.docs/sdk_developers/training/setup/setup_windows.mdfile..github/ISSUE_TEMPLATE/01_good_first_issue_candidate.yml,.github/ISSUE_TEMPLATE/02_good_first_issue.yml,README.md, andCONTRIBUTING.mdto point to the new location. [1] [2] [3] [4]Related issue(s):
Fixes #1953
Notes for reviewer:
Checklist