refactor(docs): migrate legacy Markdown files to MkDocs structure - #155
Merged
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
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
This PR migrates the project's legacy Markdown documentation into a structured MkDocs setup.
It introduces a new
mkdocs.ymlconfiguration, organizes existing documentation into appropriate sections, and prepares the repository for automated deployment via GitHub Actions.Changes
.mdfiles into MkDocs-compatible pagesmkdocs.ymlconfiguration filedocs/deploy_docs.yml)Motivation
The previous documentation consisted of scattered Markdown files without a unified structure.
Migrating to MkDocs improves:
Type of change
Checklist