docs(mkdocs): create mkdocs site & thinner readme#44
Merged
Conversation
github-actions
Bot
added
documentation
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
This pull request updates the documentation to provide a clearer, more user-friendly experience for installation, support, and development workflows. The changes focus on simplifying instructions, improving navigation, and ensuring technical accuracy for prerequisites.
Documentation improvements:
.github/INSTALL.md: Rewrote the installation guide to emphasize quick steps, direct users to official documentation for advanced help, and condensed troubleshooting and configuration information into linked resources. The guide now highlights both VS Code Marketplace and command-line installation, with a streamlined development workflow and a quick test section..github/SUPPORT.md: Replaced the placeholder with a comprehensive support guide, including links to troubleshooting, configuration, and FAQ documentation. Added clear instructions for getting help, filing issues, and enabling debug mode in VS Code.Technical updates:
.github/development.md: Updated development prerequisites to require Node.js 20.x+ and Python 3.10+ (instead of older versions), reflecting current recommendations and end-of-life status for Python <3.10.