docs(plugins): standardize on pnpx and unify plugin docs structure#123
Merged
Conversation
- Replace every npx / bare-bin CLI instruction across docs/plugins/*.md, plugins/*/README.md, and cli.ts doc-comments with `pnpx @devframes/plugin-xxxx`. - Give every docs/plugins/*.md page the same shape: What it does, Standalone, Mount into a Vite host, Programmatic, RPC surface, Source. - Fill in the gaps this surfaced: a fixed package name in a11y.md, and new Standalone / Mount / Programmatic / RPC surface / Source sections for og.md, a11y.md, data-inspector.md, and terminals.md. Docs only; generated with the help of an agent.
✅ Deploy Preview for devfra ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
2 participants
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
docs/plugins/*.md,plugins/*/README.md, and thecli.tsdoc-comments now readspnpx @devframes/plugin-xxxx— no morenpx, and no more bare bin names run directly (e.g.devframe-data-inspector,devframe-git).docs/plugins/*.mdpage now follows the same shape:What it does→ (plugin-specific sections) →Standalone→Mount into a Vite host→Programmatic→RPC surface→Source.a11y.mdhad the wrong package name (@devframes/a11yinstead of@devframes/plugin-a11y) and was missingStandalone,Mount into a Vite host,Programmatic, andRPC surfacesections.og.mdwas missing thePackage/framework line,What it does,Mount into a Vite host,RPC surface, andSourcesections.data-inspector.mdwas missing aSourcesection and aProgrammaticsection, and its standalone section used the bare CLI bin instead ofpnpx.terminals.mdwas missing anRPC surfacetable.Docs only — no behavior changes.
Generated with the help of an agent.