docs: Add local development setup guide and update deployment for DocGen #640
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.
Purpose
This pull request updates documentation to make local development setup clearer and easier to follow. The main changes include renaming and expanding the local development guide, adding troubleshooting steps, and improving navigation to local setup instructions from the main README and deployment guide.
Local Development Documentation Improvements:
docs/LocalDebuggingSetup.mdtodocs/LocalDevelopmentSetup.mdand updated its title and section headings for clarity and consistency.Troubleshooting and Support:
Navigation and Accessibility:
README.mdanddocs/DeploymentGuide.mdto the new local development setup guide, making it easier for users to find local setup instructions. [1] [2]Reference Documentation:
Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information