mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 07:00:43 +00:00
docs: typography hygiene across 6 pages
Replaced 66 typography characters (curly quotes, apostrophes, em/en dashes, non-breaking hyphens) with ASCII equivalents per docs/CLAUDE.md heading and content hygiene rules. - docs/channels/mattermost.md: 12 chars - docs/tools/plugin.md: 11 chars - docs/providers/xai.md: 11 chars - docs/plugins/building-plugins.md: 11 chars - docs/concepts/streaming.md: 11 chars - docs/concepts/model-providers.md: 11 chars
This commit is contained in:
@@ -36,7 +36,7 @@ install from npm during the launch cutover.
|
||||
Add a model provider (LLM, proxy, or custom endpoint)
|
||||
</Card>
|
||||
<Card title="Tool / hook plugin" icon="wrench" href="/plugins/hooks">
|
||||
Register agent tools, event hooks, or services — continue below
|
||||
Register agent tools, event hooks, or services - continue below
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
@@ -126,7 +126,7 @@ and provider plugins have dedicated guides linked above.
|
||||
```
|
||||
|
||||
`definePluginEntry` is for non-channel plugins. For channels, use
|
||||
`defineChannelPluginEntry` — see [Channel Plugins](/plugins/sdk-channel-plugins).
|
||||
`defineChannelPluginEntry` - see [Channel Plugins](/plugins/sdk-channel-plugins).
|
||||
For full entry point options, see [Entry Points](/plugins/sdk-entrypoints).
|
||||
|
||||
</Step>
|
||||
@@ -144,7 +144,7 @@ and provider plugins have dedicated guides linked above.
|
||||
Bare package specs like `@myorg/openclaw-my-plugin` install from npm during
|
||||
the launch cutover. Use `clawhub:` when you want ClawHub resolution.
|
||||
|
||||
**In-repo plugins:** place under the bundled plugin workspace tree — automatically discovered.
|
||||
**In-repo plugins:** place under the bundled plugin workspace tree - automatically discovered.
|
||||
|
||||
```bash
|
||||
pnpm test -- <bundled-plugin-root>/my-plugin/
|
||||
@@ -220,7 +220,7 @@ available) or optional (user opt-in):
|
||||
|
||||
```typescript
|
||||
register(api) {
|
||||
// Required tool — always available
|
||||
// Required tool - always available
|
||||
api.registerTool({
|
||||
name: "my_tool",
|
||||
description: "Do a thing",
|
||||
@@ -230,7 +230,7 @@ register(api) {
|
||||
},
|
||||
});
|
||||
|
||||
// Optional tool — user must add to allowlist
|
||||
// Optional tool - user must add to allowlist
|
||||
api.registerTool(
|
||||
{
|
||||
name: "workflow_tool",
|
||||
@@ -338,7 +338,7 @@ import { ... } from "openclaw/plugin-sdk";
|
||||
For the full subpath reference, see [SDK Overview](/plugins/sdk-overview).
|
||||
|
||||
Within your plugin, use local barrel files (`api.ts`, `runtime-api.ts`) for
|
||||
internal imports — never import your own plugin through its SDK path.
|
||||
internal imports - never import your own plugin through its SDK path.
|
||||
|
||||
For provider plugins, keep provider-specific helpers in those package-root
|
||||
barrels unless the seam is truly generic. Current bundled examples:
|
||||
@@ -398,8 +398,8 @@ reserved surfaces, not as the default pattern for new third-party plugins.
|
||||
|
||||
## Related
|
||||
|
||||
- [Plugin Architecture](/plugins/architecture) — internal architecture deep dive
|
||||
- [SDK Overview](/plugins/sdk-overview) — Plugin SDK reference
|
||||
- [Manifest](/plugins/manifest) — plugin manifest format
|
||||
- [Channel Plugins](/plugins/sdk-channel-plugins) — building channel plugins
|
||||
- [Provider Plugins](/plugins/sdk-provider-plugins) — building provider plugins
|
||||
- [Plugin Architecture](/plugins/architecture) - internal architecture deep dive
|
||||
- [SDK Overview](/plugins/sdk-overview) - Plugin SDK reference
|
||||
- [Manifest](/plugins/manifest) - plugin manifest format
|
||||
- [Channel Plugins](/plugins/sdk-channel-plugins) - building channel plugins
|
||||
- [Provider Plugins](/plugins/sdk-provider-plugins) - building provider plugins
|
||||
|
||||
Reference in New Issue
Block a user