Skip to content

good first issue: Document plugin configuration options #498

Open

Description

@vgmartinez

Context

From .github/GOOD_FIRST_ISSUES.md task #3.

Comprehensive plugin config reference for built-in plugins.

Acceptance criteria

  • docs/plugins/ with docs for ratelimit, tokenratelimit, requestsize, semanticcache, cors
  • Fields, types, defaults
  • Example JSON per plugin
  • Linked from README Plugins section

Comment to claim.

Activity

  1. vgmartinez commented on Aug 23, 2026

    @vgmartinez
    ContributorAuthor

    Starter notes if anyone picks this up:

    1. Start from existing plugin docs / config examples in the repo (search plugins under docs and config samples) — document each option's type, default, and effect.
    2. Prefer a table or per-plugin sections over a wall of prose; link to the Go struct or YAML sample that defines the field.
    3. Call out fail-closed vs fail-open behavior for rate/token limits where it matters.
    4. Acceptance: a contributor can configure the documented plugins against make up without reading source.

    Comment here to claim — happy to review a draft outline before a big PR.

  2. vgmartinez commented on Aug 23, 2026

    @vgmartinez
    ContributorAuthor

    Related design note just opened for evaluators/contributors who ask "why not just middleware?":

    → #519

    If your docs PR covers policy / fail-closed behavior, linking that FAQ from the plugin docs outline would help first-time readers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions