Repository navigation
docs: move local setup and build instructions into SETUP.md - #498
Open
ishikajain-234 wants to merge 1 commit into
Open
ishikajain-234 wants to merge 1 commit into
ishikajain-234 wants to merge 1 commit into
Conversation
Extract environment setup (conda/pip) and local build/preview instructions from README.md into a dedicated SETUP.md file to keep the README concise and focused on the project overview. Fixes numfocus#466
❌ Deploy Preview for stupendous-kringle-a86e81 failed.
|
This branch has not been deployed
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.
Description of Changes
This PR resolves #466 by extracting the local setup, installation, and build documentation from
README.mdinto a dedicatedSETUP.mdfile:SETUP.md: Contains comprehensive instructions for environment setup (both Conda and pip/venv), dependency installation, local Sphinx building, and local preview/server options.README.md: Replaced the verbose build instructions under## How to Build and Run the Site Locallywith a direct link and reference toSETUP.md.Related Issue
Fixes #466
Type of Change
Additional Notes (Optional)
Documentation restructuring; verified markdown syntax rendering.
Checklist