Skip to content

Commit cc674de

Browse files
Parkreinerbpmct
andauthored
docs: add API documentation for Coder plugin (#15)
* docs: finish drafts for hooks/types README files * wip: add stub for components README * fix: remove typo in main docs * wip: add stub for component docs * wip: add outline for component documentation * docs: add documentation for CoderAuthWrapper and CoderErrorBoundary * docs: finish up section for CoderProvider * fix: update typo in library name * docs: finish section for CoderAppConfig * fix: export useWorkspacesCardContext * docs: finish section for useWorkspacesCardContext * wip: add stubs for CoderWorkspacesCard * fix: update link in main directory README * docs: add more info to component docs * fix: ensure link configs are combined properly * docs: finish docs for CreateWorkspacesLink * docs: finish section for ExtraActionsButton * docs: finish section for HeaderRow * docs: finish Root * docs: finish section for SearchBox * docs: finish rough draft of API docs * fix: fill in missing section for CoderProvider * chore: move API docs up one level * docs: fill in link for TODO comment * fix: reword docs message for clarity * Update plugins/backstage-plugin-coder/docs/README.md Co-authored-by: Ben Potter <me@bpmct.net> * fix: update version for Coder plugin * docs: add info about useCoderEntityConfig * fix: make sure all exported components have unique name values * fix: make sure all values are properly exported at top-level plugin root * fix: remove forwardRef from exported sub-components * fix: remove forwardRef from Root --------- Co-authored-by: Ben Potter <me@bpmct.net>
1 parent 12570c7 commit cc674de

File tree

11 files changed

+1167
-173
lines changed

11 files changed

+1167
-173
lines changed

plugins/backstage-plugin-coder/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ the devcontainer.
8989
);
9090
```
9191

92-
<!-- > Note: You can also wrap a single page or component with `CoderProvider` if you only need Coder in a specific part of your app. See our [API reference](#TODO) for more details. -->
92+
**Note:** You can also wrap a single page or component with `CoderProvider` if you only need Coder in a specific part of your app. See our [API reference](./docs/README.md) (particularly the section on [the `CoderProvider` component](./docs/components.md#coderprovider)) for more details.
9393

9494
1. Add the `CoderWorkspacesCard` card to the entity page in your app:
9595

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Plugin API Reference – Coder for Backstage
2+
3+
For users who need more information about how to extend and modify the Coder plugin. For general setup, please see our main [README](../README.md).
4+
5+
## Documentation directory
6+
7+
- [Components](./components.md)
8+
- [Custom React hooks](./hooks.md)
9+
- [Important types](./types.md)

0 commit comments

Comments
 (0)