feat: Overhaul documentation and add advanced usage sections#25
Merged
feat: Overhaul documentation and add advanced usage sections#25
Conversation
- Added advanced usage documentation covering custom flag types, dynamic flags, environment-based flags, user-based flags, feature rollouts, and best practices. - Introduced comprehensive API references for Flag and Flaggle classes. - Created changelog to document notable changes and releases. - Enhanced configuration documentation with examples for environment variables and configuration files. - Expanded contributing guidelines to encourage community involvement and maintain code quality. - Developed FAQ section addressing common questions and troubleshooting tips. - Implemented integration guides for FastAPI, Flask, Django, Typer, and other environments. - Added support for MkDocs with various plugins for improved documentation experience. - Included license information under MIT License. - Established supported operations documentation detailing flag management and JSON schema for flags endpoint.
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.
Summary
This PR overhauls the documentation and adds advanced usage sections, along with improvements to development and release workflows.
Key Changes by Commit
Documentation Overhaul & Advanced Usage
FlagandFlaggleclasses.(commit)
Development Environment
devcontainerwith a Dockerfile and configuration for a Python development environment.(commit)
Release Workflow
(commit)
CI/CD Improvements
(commit)