Skip to content

Conversation

@oasaph
Copy link
Contributor

@oasaph oasaph commented Jun 10, 2025

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

    • Added advanced usage docs for custom flag types, dynamic flags, environment/user-based flags, feature rollouts, and best practices.
    • Introduced comprehensive API references for the Flag and Flaggle classes.
    • Created a changelog for documenting notable changes and releases.
    • Enhanced configuration documentation with examples for environment variables and config files.
    • Expanded contributing guidelines to encourage community involvement and maintain code quality.
    • Developed an FAQ addressing common questions and troubleshooting tips.
    • Implemented integration guides for FastAPI, Flask, Django, Typer, and other environments.
    • Added support for MkDocs and various plugins to improve the documentation experience.
    • Included MIT license information.
    • Documented supported operations and JSON schema for the flags endpoint.
      (commit)
  • Development Environment

    • Set up a devcontainer with a Dockerfile and configuration for a Python development environment.
      (commit)
  • Release Workflow

    • Implemented pre-release versioning and release promotion workflow.
      (commit)
  • CI/CD Improvements

    • Changed workflow runners to self-hosted for build jobs.
      (commit)

oasaph and others added 16 commits June 10, 2025 10:53
- 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.
@oasaph oasaph merged commit 7522c2d into main Aug 21, 2025
3 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants