[Docs] Add MkDocs documentation and deployment workflow#47
Merged
Conversation
This commit introduces a comprehensive documentation site built with MkDocs and Material for MkDocs. It also sets up a GitHub Actions workflow to automatically build and deploy the documentation to GitHub Pages.
Key changes include:
* **Documentation Site:**
* Added a new `docs/` directory containing detailed documentation on setup, usage, and advanced features like custom mappings and type converters.
* A `mkdocs.yml` configuration file has been added to define the site structure, theme, and navigation.
* **README Update:**
* The `README.md` has been simplified, removing detailed usage instructions and adding a prominent link to the new documentation site.
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 commit introduces a comprehensive documentation site built with MkDocs and Material for MkDocs. It also sets up a GitHub Actions workflow to automatically build and deploy the documentation to GitHub Pages.
Key changes include:
Documentation Site:
docs/directory containing detailed documentation on setup, usage, and advanced features like custom mappings and type converters.mkdocs.ymlconfiguration file has been added to define the site structure, theme, and navigation.README Update:
README.mdhas been simplified, removing detailed usage instructions and adding a prominent link to the new documentation site.