Commit b7735e0
add plugin docs (#1025)
* feat(docs): add 'Hosted UI' section and links across multiple languages
- Introduced 'Hosted UI' terminology in the English, Chinese, and Japanese plugin documentation, enhancing clarity on interactive TSX panels and Markdown guides.
- Updated the sidebar and quick start guides to include links to the new 'Hosted UI' section, improving navigation for users.
- Adjusted the structure of plugin directories in documentation to reflect the new UI components and their organization.
* docs: update 'Hosted UI' documentation with detailed usage guidelines and examples
- Enhanced the 'Hosted UI' section in both English and Chinese documentation, providing clearer instructions on when to use Hosted TSX and Markdown for plugin interfaces.
- Added a minimal example layout and clarified the declaration of surfaces in `plugin.toml`.
- Improved explanations of context and actions in Python, along with a quick reference for `PluginSurfaceProps` and `HostedApi`.
- Updated the structure of the documentation to facilitate better navigation and understanding of the hosted UI components.
* docs: enhance 'Hosted UI' documentation and improve plugin configuration details
- Updated the 'Hosted UI' documentation in both English and Chinese, adding essential metadata requirements for plugins.
- Clarified the configuration of surfaces in `plugin.toml`, including permissions and context settings.
- Improved examples for Python context and action handling, ensuring better guidance for plugin developers.
- Enhanced the structure and navigation of the documentation to facilitate user understanding of hosted UI components.
---------
Co-authored-by: LocalBuilder <local@builder>1 parent b0f4e4d commit b7735e0
15 files changed
Lines changed: 1330 additions & 27 deletions
File tree
- docs
- .vitepress
- design
- plugins
- zh-CN/plugins
- frontend/plugin-manager
- scripts
- src/components/plugin/hosted/ui-kit
- plugin
- sdk/plugin
- server/application/plugins
- tests/unit
- sdk/plugin
- server
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
182 | 182 | | |
183 | 183 | | |
184 | 184 | | |
185 | | - | |
| 185 | + | |
186 | 186 | | |
187 | 187 | | |
188 | 188 | | |
189 | 189 | | |
190 | | - | |
| 190 | + | |
191 | 191 | | |
192 | 192 | | |
193 | 193 | | |
194 | 194 | | |
195 | | - | |
| 195 | + | |
196 | 196 | | |
197 | 197 | | |
198 | 198 | | |
| |||
204 | 204 | | |
205 | 205 | | |
206 | 206 | | |
| 207 | + | |
207 | 208 | | |
208 | 209 | | |
209 | 210 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
128 | 128 | | |
129 | 129 | | |
130 | 130 | | |
131 | | - | |
| 131 | + | |
132 | 132 | | |
133 | 133 | | |
134 | 134 | | |
| |||
0 commit comments