docs(plugins): mark all plugins as experimental#52
Merged
Conversation
Flag the first-party @devframes/plugin-* packages as experimental so consumers know their APIs may change before stabilizing. Adds an @experimental JSDoc tag to each plugin's exported devframe factory (a11y, code-server, git, inspect, terminals) and a "> [!WARNING] Experimental" callout to the four plugin READMEs.
✅ 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.
What
Marks all five first-party
@devframes/plugin-*packages as experimental so consumers understand their APIs may still change before stabilizing.Two complementary signals, mirroring how the repo already flags its agent-native surface:
@experimentalJSDoc on each plugin's exported devframe factory:createA11yDevframe,createCodeServerDevframe,createGitDevframe,createInspectDevframe, andcreateTerminalsDevframe.> [!WARNING] ExperimentalREADME callout on the four plugins that ship a README (a11y,code-server,git,inspect).Why
These plugins are an early ecosystem/dogfooding effort and their surfaces are expected to move. Flagging them sets the right stability expectations for early adopters without a major version commitment.
Notes
terminalshas no README, so it receives the JSDoc tag only.tsc --noEmitacross all five plugin packages.This PR was created with the help of an agent.