docs: use mkdocs-material #2
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.
This pull request introduces significant updates to documentation and deployment workflows for the
holo-fnproject. The changes include setting up automated documentation deployment, enhancing contribution guidelines, and configuring the MkDocs framework for improved documentation hosting.Documentation Deployment and Configuration:
.github/workflows/publish-docs.yml: Added a GitHub Actions workflow to automatically deploy documentation to GitHub Pages whenever changes are pushed to thedocsbranch. The workflow usesmkdocs-materialfor site generation.mkdocs.yml: Configured MkDocs with a Material theme, Google Analytics, and navigation for key sections likeEither,Maybe, andResult. This ensures a structured and visually appealing documentation site.Documentation Enhancements:
docs/contributing.md: Added a comprehensive guide for contributors, including setup instructions, testing, building, and creating pull requests. This makes it easier for new contributors to get started.README.md: Updated the link to the contribution guidelines to point to the hosted documentation site, improving accessibility.