Skip to content

Commit 5567e84

Browse files
authored
docs: add goclaw-source metadata and badge styles to EN pages (#21)
Add goclaw-source HTML comment with commit SHA and update date to all EN doc pages. Add CSS styles for the source metadata badge.
1 parent a284d2a commit 5567e84

107 files changed

Lines changed: 562 additions & 312 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

advanced/api-keys-rbac.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,8 @@ When a key is created or revoked, a `cache.invalidate` event is broadcast on the
225225

226226
## What's Next
227227

228-
- [Authentication & OAuth](authentication.md) — gateway token and OAuth flow
229-
- [Exec Approval](exec-approval.md) — require `operator.approvals` scope
230-
- [Security Hardening](../deployment/security-hardening.md) — full 5-layer permission overview
228+
- [Authentication & OAuth](#authentication) — gateway token and OAuth flow
229+
- [Exec Approval](#exec-approval) — require `operator.approvals` scope
230+
- [Security Hardening](#deploy-security) — full 5-layer permission overview
231+
232+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/authentication.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,5 +192,7 @@ source .env.local
192192

193193
## What's Next
194194

195-
- [Providers Overview](../providers/overview.md) — all supported LLM providers and how to configure them
196-
- [Hooks & Quality Gates](../advanced/hooks-quality-gates.md) — add validation to agent outputs
195+
- [Providers Overview](#providers-overview) — all supported LLM providers and how to configure them
196+
- [Hooks & Quality Gates](#hooks-quality-gates) — add validation to agent outputs
197+
198+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/browser-automation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,5 +253,7 @@ Returns:
253253

254254
## What's Next
255255

256-
- [Exec Approval](../advanced/exec-approval.md) — require human sign-off before running commands
257-
- [Hooks & Quality Gates](../advanced/hooks-quality-gates.md) — add pre/post checks to agent actions
256+
- [Exec Approval](#exec-approval) — require human sign-off before running commands
257+
- [Hooks & Quality Gates](#hooks-quality-gates) — add pre/post checks to agent actions
258+
259+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/caching.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,5 +88,7 @@ Both backends implement the same interface:
8888

8989
## What's Next
9090

91-
- [Database Setup](../deployment/database-setup.md) — PostgreSQL configuration
92-
- [Production Checklist](../deployment/production-checklist.md) — Deploy with confidence
91+
- [Database Setup](#deploy-database) — PostgreSQL configuration
92+
- [Production Checklist](#deploy-checklist) — Deploy with confidence
93+
94+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/channel-instances.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,8 @@ DELETE /v1/channels/instances/{id}/writers/{userId}?group_id=<group_id>
244244

245245
## What's Next
246246

247-
- [Channel Overview](../channels/overview.md)
248-
- [Multi-Channel Setup](../recipes/multi-channel-setup.md)
249-
- [Multi-Tenancy](../core-concepts/multi-tenancy.md)
247+
- [Channel Overview](#channels-overview)
248+
- [Multi-Channel Setup](#recipe-multi-channel)
249+
- [Multi-Tenancy](#multi-tenancy)
250+
251+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/cli-credentials.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ CLI Credentials let you define named credential sets (API keys, tokens, connecti
1010

1111
## What's Next
1212

13-
- [Exec Approval](exec-approval.md)
14-
- [API Keys & RBAC](api-keys-rbac.md)
15-
- [Security Hardening](../deployment/security-hardening.md)
13+
- [Exec Approval](#exec-approval)
14+
- [API Keys & RBAC](#api-keys-rbac)
15+
- [Security Hardening](#deploy-security)
16+
17+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/context-pruning.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ As agents run long tasks, tool results accumulate in the conversation history. L
1111
1. **Soft trim** — truncate oversized tool results to head + tail, dropping the middle.
1212
2. **Hard clear** — if the context is still too full, replace entire tool results with a short placeholder.
1313

14-
Context pruning is distinct from [session compaction](../core-concepts/sessions-and-history.md). Compaction permanently summarizes and truncates conversation history. Pruning is non-destructive: the original tool results remain in the session store and are never modified — only the message slice sent to the LLM is trimmed.
14+
Context pruning is distinct from [session compaction](#sessions-and-history). Compaction permanently summarizes and truncates conversation history. Pruning is non-destructive: the original tool results remain in the session store and are never modified — only the message slice sent to the LLM is trimmed.
1515

1616
---
1717

@@ -210,12 +210,14 @@ Increase `softTrim.headChars` and `softTrim.tailChars`, or raise `softTrim.maxCh
210210

211211
**Context still overflows despite pruning**
212212

213-
Pruning only acts on tool results. If long user messages or system prompt components dominate the context, pruning will not help. Consider [session compaction](../core-concepts/sessions-and-history.md) or reduce the system prompt size.
213+
Pruning only acts on tool results. If long user messages or system prompt components dominate the context, pruning will not help. Consider [session compaction](#sessions-and-history) or reduce the system prompt size.
214214

215215
---
216216

217217
## What's Next
218218

219-
- [Sessions & History](../core-concepts/sessions-and-history.md) — session compaction, history limits
220-
- [Memory System](../core-concepts/memory-system.md) — persistent memory across sessions
221-
- [Configuration Reference](../reference/config-reference.md) — full agent config reference
219+
- [Sessions & History](#sessions-and-history) — session compaction, history limits
220+
- [Memory System](#memory-system) — persistent memory across sessions
221+
- [Configuration Reference](#config-reference) — full agent config reference
222+
223+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/cost-tracking.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ The check runs once per request, before any LLM calls. Sub-agent delegations run
235235

236236
## What's Next
237237

238-
- [Usage & Quota](usage-quota.md) — per-user request limits and token counts
239-
- [Observability](../deployment/observability.md) — OpenTelemetry export for spans including cost fields
240-
- [Configuration Reference](../reference/config-reference.md) — full `telemetry` config options
238+
- [Usage & Quota](#usage-quota) — per-user request limits and token counts
239+
- [Observability](#deploy-observability) — OpenTelemetry export for spans including cost fields
240+
- [Configuration Reference](#config-reference) — full `telemetry` config options
241+
242+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/custom-tools.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,8 @@ The check runs on the **fully rendered command** after all `{{.param}}` substitu
187187

188188
## What's Next
189189

190-
- [MCP Integration](./mcp-integration.md) — connect external tool servers instead of writing shell commands
191-
- [Exec Approval](./exec-approval.md) — require human approval before commands run
192-
- [Sandbox](./sandbox.md) — run commands inside Docker for extra isolation
190+
- [MCP Integration](#mcp-integration) — connect external tool servers instead of writing shell commands
191+
- [Exec Approval](#exec-approval) — require human approval before commands run
192+
- [Sandbox](#sandbox) — run commands inside Docker for extra isolation
193+
194+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

advanced/exec-approval.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,8 @@ Set `"always": true` to permanently allow this binary for the lifetime of the pr
194194

195195
## What's Next
196196

197-
- [Sandbox](./sandbox.md) — run exec commands inside an isolated Docker container
198-
- [Custom Tools](./custom-tools.md) — define tools backed by shell commands
199-
- [Security Hardening](../deployment/security-hardening.md) — full five-layer security overview
197+
- [Sandbox](#sandbox) — run exec commands inside an isolated Docker container
198+
- [Custom Tools](#custom-tools) — define tools backed by shell commands
199+
- [Security Hardening](#deploy-security) — full five-layer security overview
200+
201+
<!-- goclaw-source: 57754a5 | updated: 2026-03-18 -->

0 commit comments

Comments
 (0)