For each plugin, we need to make sure that we expose more thorough API docs for power users, or just to act as a supplement for when the TypeScript type definitions and JSDoc comments can't communicate everything.
Should-haves
[ ] Devcontainers plugin API docs need a note about VS Code default branch support - no other branches are supported so we always open to the default branch. 🧵 here
[ ] Documentation for each plugin
[ ] Documentation for each exposed function/component/hook
[ ] Type signatures (need to figure out a way to communicate the HTML type signatures without bombarding people with 200+ properties)
[ ] Error behavior (Does the component throw? Does it communicate with Backstage's error API?)
[ ] Other recommendations for using the value (e.g., we encourage people to define their CoderAppConfig value outside a component, to ensure the value remains as stable as possible)
For each plugin, we need to make sure that we expose more thorough API docs for power users, or just to act as a supplement for when the TypeScript type definitions and JSDoc comments can't communicate everything.
Should-haves
CoderAppConfigvalue outside a component, to ensure the value remains as stable as possible)