Update documentation guide for VitePress and Markdown#8161
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request successfully migrates the documentation contribution guide from ReStructuredText/Sphinx to Markdown/VitePress, aligning with the project's transition to a modern documentation stack.
Changes:
- Updated all file extension references from
.rstto.mdthroughout the guide - Replaced ReST-specific syntax documentation with comprehensive Markdown/VitePress guides
- Removed Sphinx-specific features (PHP domain directives,
:orphan:,:noindex:) - Added VitePress-specific features including frontmatter, custom containers, code highlighting with line numbers, and enhanced link handling
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
Migrates contributing documentation from ReStructuredText/Sphinx to Markdown/VitePress.
Changes
.rstreferences to.md:orphan:,:noindex:)