Docs: scaffold plugin SDK reference phase 1#51700
Closed
dutifulbob wants to merge 0 commit intoopenclaw:mainfrom
Closed
Docs: scaffold plugin SDK reference phase 1#51700dutifulbob wants to merge 0 commit intoopenclaw:mainfrom
dutifulbob wants to merge 0 commit intoopenclaw:mainfrom
Conversation
Contributor
Greptile SummaryThis PR adds a repo-local implementation plan for Mintlify-native generated Plugin SDK reference docs ( Key points:
Confidence Score: 5/5
Last reviewed commit: "Docs: add plugin SDK..." |
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
Describe the problem and fix in 2–5 bullets:
mainto currentupstream/main, addedexperiments/plugin-sdk-docs-implementation-plan.md, added the Phase 1docs/reference/plugin-sdk/scaffold, addedscripts/lib/plugin-sdk-doc-metadata.ts, addeddocs/docs.jsonnav entries, and linked the current plugin guides to the new reference area.Change Type (select all)
Scope (select all touched areas)
Linked Issue/PR
User-visible / Behavior Changes
Security Impact (required)
Yes/No) NoYes/No) NoYes/No) NoYes/No) NoYes/No) NoYes, explain risk + mitigation:Repro + Verification
Environment
Steps
mainto currentupstream/main.experiments/.mainand update the existing PR.Expected
mainis rebased to current upstream.Actual
pnpm check:docspassed.pnpm checklint stages unrelated to this docs work (extensions/openai/media-understanding-provider.tsandextensions/openai/openai-codex-provider.tsimport-boundary drift). I did not broaden this PR into that unrelated cleanup.Evidence
Attach at least one:
Human Verification (required)
What you personally verified (not just CI), and how:
maintoupstream/main, created the plan file, created the Phase 1 reference scaffold, added nav entries and guide links, ranpnpm check:docs, pushedorigin/main, and updated this PR.docs/docs.jsonparses, kept the visible nav small, and kept generated module pages explicitly deferred to the next phase.Review Conversations
If a bot review conversation is addressed by this PR, resolve that conversation yourself. Do not leave bot review conversation cleanup for maintainers.
Compatibility / Migration
Yes/No) YesYes/No) NoYes/No) NoFailure Recovery (if this breaks)
f8b5d25192,57ab43a31f, and88e896e350docs/reference/plugin-sdk/*,scripts/lib/plugin-sdk-doc-metadata.ts,docs/docs.json,docs/plugins/building-plugins.md,docs/plugins/sdk-migration.md,experiments/plugin-sdk-docs-implementation-plan.md,src/memory/embeddings-openai.ts,src/tts/tts.tsRisks and Mitigations
List only real risks for this PR. Add/remove entries as needed. If none, write
None.