Skip to content

docs(packages): configure plugins via stars.config keys - #100

Merged
kodiakhq[bot] merged 1 commit into
mainfrom
mintlify/0decdf93
Oct 22, 2026
Merged

kodiakhq[bot] merged 1 commit into
mainfrom
mintlify/0decdf93

Conversation

@mintlify

@mintlify mintlify Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents that every @wolfstar/plugin-* module now reads its options from a top-level stars.config key (meta.configKey).

Changes

  • Plugin pages (api, broker, i18next, logger, scheduled-tasks) show the key form first and explain that the [specifier, options] tuple still works and wins over the key.
  • Note the @wolfstar/kit ^0.2.0 requirement and the optional @wolfstar/schema peer that types the keys. Users import the module in stars.config.ts to load that type.
  • cache, gateway, sharder, and subcommands-advanced pages note that their key is reserved and takes no options yet.
  • Broker page clarifies that redis stays in ClientOptions.broker.
  • Added a package-to-key table in the plugins guide.

Context

@mintlify
mintlify Bot requested a review from RedStar071 as a code owner October 22, 2026 07:10
@mintlify

mintlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
stars-components 🟢 Ready View Preview Oct 22, 2026, 7:13 AM

@coldtea-pr-lens

Copy link
Copy Markdown

Note

mintlify[bot] opened this pull request, so PR Lens left it undrawn. Comment @pr-lens draw to draw it

github.comment.notice: false in .github/pr-lens.yml turns this note off

@wolfstarbot wolfstarbot added content:guide Changes in documentation/guide/ content:packages Changes in documentation/packages/ (package landing pages) labels Oct 22, 2026
@pullfrog

pullfrog Bot commented Oct 22, 2026

Copy link
Copy Markdown

The Semantic Pull Requests check fails because the title has no Conventional Commits type(scope): prefix. I can't rename the PR myself: no available tool edits a PR title.

Proposed title:

docs(packages): configure plugins via stars.config keys

The PR mostly changes plugin pages under documentation/packages. The only guide change is the package-to-key table in the plugins guide. If you prefer the guide scope, docs(guide): configure plugins via stars.config keys is also valid.

Next step: edit the title in the GitHub UI. The check re-runs when the title changes. No commits were pushed.

Pullfrog  | View workflow run | via Pullfrog | Using claude-sonnet-5-5 | 𝕏

@RedStar071 RedStar071 changed the title Update from code changes: configure plugins via stars.config keys docs(packages): configure plugins via stars.config keys Oct 22, 2026
@kodiakhq
kodiakhq Bot merged commit 0e5380f into main Oct 22, 2026
12 of 13 checks passed
@kodiakhq
kodiakhq Bot deleted the mintlify/0decdf93 branch October 22, 2026 09:00

This branch was successfully deployed

1 active deployment
staging — 2ae0ca81 Deployed Oct 22, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:guide Changes in documentation/guide/ content:packages Changes in documentation/packages/ (package landing pages)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants