docs: improve PySyft documentation setup instructions#9388
Open
Nitya-Choudhary wants to merge 1 commit intoOpenMined:devfrom
Open
docs: improve PySyft documentation setup instructions#9388Nitya-Choudhary wants to merge 1 commit intoOpenMined:devfrom
Nitya-Choudhary wants to merge 1 commit intoOpenMined:devfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary: Updated the PySyft documentation setup guide in docs/README.md to improve clarity and readability.
Motivation: The previous instructions were a bit dense. This PR reorganizes the setup into two clear methods (Native vs. Tox), adds a prerequisites section, and includes a "Troubleshooting Tips" sidebar to help new contributors resolve common environment issues faster.
Context: These changes ensure that the documentation setup process is scannable and user-friendly for developers of all experience levels.
##Affected Dependencies
None. This is a documentation-only change.
##How has this been tested?
Manual Verification: I followed the updated instructions step-by-step in my local PowerShell environment to ensure the make html and tox -e syft.docs commands work exactly as described.
Visual Check: Verified the Markdown rendering in VS Code to ensure all headers and code blocks are formatted correctly.
