Skip to content

docs: move Windows setup guide and add missing setup sections#1958

Merged
manishdait merged 2 commits intohiero-ledger:mainfrom
danielmarv:docs-win-setup
Mar 11, 2026
Merged

docs: move Windows setup guide and add missing setup sections#1958
manishdait merged 2 commits intohiero-ledger:mainfrom
danielmarv:docs-win-setup

Conversation

@danielmarv
Copy link
Contributor

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:

  • Added a new, comprehensive docs/sdk_developers/setup_windows.md guide for Windows setup, including prerequisites, dependency management, environment setup, troubleshooting, and optional dependencies.
  • Removed the outdated and now redundant docs/sdk_developers/training/setup/setup_windows.md file.
  • Updated all references to the Windows setup guide in .github/ISSUE_TEMPLATE/01_good_first_issue_candidate.yml, .github/ISSUE_TEMPLATE/02_good_first_issue.yml, README.md, and CONTRIBUTING.md to point to the new location. [1] [2] [3] [4]
  • Updated the changelog to note the relocation and improvement of the Windows setup guide.

Related issue(s):

Fixes #1953

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

… clarity

Signed-off-by: Daniel Ntege <danientege785@gmail.com>
… clarity

Signed-off-by: Daniel Ntege <danientege785@gmail.com>
Copilot AI review requested due to automatic review settings March 11, 2026 10:49
@danielmarv danielmarv requested review from a team as code owners March 11, 2026 10:49
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: fc9ae478-3af3-407c-9734-0a23a3c47aa3

📥 Commits

Reviewing files that changed from the base of the PR and between 8fa3dda and f7f6044.

📒 Files selected for processing (7)
  • .github/ISSUE_TEMPLATE/01_good_first_issue_candidate.yml
  • .github/ISSUE_TEMPLATE/02_good_first_issue.yml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • README.md
  • docs/sdk_developers/setup_windows.md
  • docs/sdk_developers/training/setup/setup_windows.md
💤 Files with no reviewable changes (1)
  • docs/sdk_developers/training/setup/setup_windows.md

Walkthrough

The Windows setup guide was relocated from docs/sdk_developers/training/setup/setup_windows.md to docs/sdk_developers/setup_windows.md to improve discoverability. All references across documentation, issue templates, and contributing guides were updated to reflect the new path.

Changes

Cohort / File(s) Summary
Documentation Links Updated
README.md, CONTRIBUTING.md, .github/ISSUE_TEMPLATE/01_good_first_issue_candidate.yml, .github/ISSUE_TEMPLATE/02_good_first_issue.yml
Updated internal references to Windows setup guide from docs/sdk_developers/training/setup/setup_windows.md to docs/sdk_developers/setup_windows.md.
Changelog Entry
CHANGELOG.md
Added documentation entry noting the relocation of the Windows setup guide and mention of added setup sections.
File Relocation
docs/sdk_developers/setup_windows.md (added), docs/sdk_developers/training/setup/setup_windows.md (deleted)
Moved Windows setup guide from nested training directory to top-level SDK developers directory. New file contains identical content covering prerequisites, repository setup, dependency installation via uv, protobuf generation, environment configuration, and troubleshooting steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: moving the Windows setup guide to a more accessible location and adding missing setup sections.
Description check ✅ Passed The description is comprehensive and clearly explains the reorganization, improvements, updated references, and changelog updates related to the Windows setup documentation.
Linked Issues check ✅ Passed The PR addresses all key requirements from issue #1953: moves setup_windows.md to a higher-level location (docs/sdk_developers/), updates it with complete setup instructions, adds direct links in README and other files, includes changelog entry, and references the issue. CI, tests, and DCO/GPG signing status cannot be verified from provided context.
Out of Scope Changes check ✅ Passed All changes are directly related to reorganizing and improving the Windows setup documentation as specified in issue #1953. No unrelated changes detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

📋 Issue Planner

Built with CodeRabbit's Coding Plans for faster development and fewer bugs.

View plan used: #1953

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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
Copy link

codecov bot commented Mar 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@aceppaluni aceppaluni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danielmarv This looks great.

I will make an issue to add information regarding chocolatey.

Thank you!

@manishdait manishdait merged commit 10a8132 into hiero-ledger:main Mar 11, 2026
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Beginner]: Update Windows Setup Guide

5 participants