Skip to content

Commit b7735e0

Browse files
wislapLocalBuilder
andauthored
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/config.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,17 +182,17 @@ function pluginsSidebar(lang: 'en' | 'zh-CN' | 'ja') {
182182
en: {
183183
group: 'Plugin Development', overview: 'Overview', quick: 'Quick Start',
184184
sdk: 'SDK Reference', dec: 'Decorators', ex: 'Examples', adv: 'Advanced Topics',
185-
best: 'Best Practices',
185+
hosted: 'Hosted UI', best: 'Best Practices',
186186
},
187187
'zh-CN': {
188188
group: '插件开发', overview: '概览', quick: '快速开始',
189189
sdk: 'SDK 参考', dec: '装饰器', ex: '示例', adv: '进阶话题',
190-
best: '最佳实践',
190+
hosted: 'Hosted UI', best: '最佳实践',
191191
},
192192
ja: {
193193
group: 'プラグイン開発', overview: '概要', quick: 'クイックスタート',
194194
sdk: 'SDK リファレンス', dec: 'デコレーター', ex: 'サンプル', adv: '高度なトピック',
195-
best: 'ベストプラクティス',
195+
hosted: 'Hosted UI', best: 'ベストプラクティス',
196196
},
197197
}[lang]
198198
const p = lang === 'en' ? '' : `/${lang}`
@@ -204,6 +204,7 @@ function pluginsSidebar(lang: 'en' | 'zh-CN' | 'ja') {
204204
{ text: t.quick, link: `${p}/plugins/quick-start` },
205205
{ text: t.sdk, link: `${p}/plugins/sdk-reference` },
206206
{ text: t.dec, link: `${p}/plugins/decorators` },
207+
...(lang === 'ja' ? [] : [{ text: t.hosted, link: `${p}/plugins/hosted-ui` }]),
207208
{ text: t.ex, link: `${p}/plugins/examples` },
208209
{ text: t.adv, link: `${p}/plugins/advanced` },
209210
{ text: t.best, link: `${p}/plugins/best-practices` },

docs/design/llm-prompt-budget.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ PR #967 之前,全仓字符长度限制散落在各模块的 magic number 里
128128
| 负面关键词检查 user 上下文条数 | `NEGATIVE_KEYWORD_CHECK_CONTEXT_ITEMS` | 3 |
129129

130130
**Drain 机制(Stage-2 单批 cap)**
131-
- 每条 fact 落盘时带 `signal_processed=False` 标记([memory/facts.py](memory/facts.py)
131+
- 每条 fact 落盘时带 `signal_processed=False` 标记([memory/facts.py](https://github.com/Project-N-E-K-O/N.E.K.O/blob/main/memory/facts.py)
132132
- `aextract_facts_and_detect_signals`**全部** unprocessed facts,按 importance DESC 取前 N=20,调 Stage-2
133133
- 成功 → `amark_signal_processed(ids)` 标记 True;失败 → 不动,下轮 idle tick 重试同一批
134134
- 多余的 fact(>20)留 `False`,下次 idle 自然 drain

0 commit comments

Comments
 (0)