Add comprehensive MkDocs documentation site#6
Merged
Conversation
Documentation Structure: - Getting Started: Installation, Quick Start - User Guide: Concepts, Creating, Parsing, Short Encoding, Serialization - Framework Integrations: SQLAlchemy, Pydantic, FastAPI - Examples: Cookbook, Real-World Patterns - Tutorial: Building a User System - API Reference: TypedUUID, Factory Functions, Exceptions, Adapters Features: - MkDocs Material theme with dark/light mode - mkdocstrings for API documentation from docstrings - GitHub Actions workflow for automatic deployment to GitHub Pages - Code highlighting, copy buttons, and navigation - Added docs optional dependency to pyproject.toml - Updated Documentation URL to GitHub Pages
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
2 participants
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.
Documentation Structure:
Features: