Skip to content

Commit 5e8099f

Browse files
docs(pages): remove overview page across all languages and clean up references
- Delete en/zh/ja overview.md - Remove overview imports, DocSlug entry and doc maps in index.ts - Drop overview sidebar item and switch default slug to quickstart in DocsPage - Remove overview-related i18n keys from en/zh/ja - Sync viewer.md heading emphasis removal to en/ja
1 parent c9acbcf commit 5e8099f

11 files changed

Lines changed: 4 additions & 282 deletions

File tree

pages/src/content/docs/en/overview.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

pages/src/content/docs/en/viewer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ The OpenTelemetry exporter is a separate concern — see
166166
[Telemetry](../telemetry/) for how to keep prompt content out of
167167
exported traces.
168168

169-
## When the viewer is *not* the right tool
169+
## When the viewer is not the right tool
170170

171171
- For programmatic post-processing (CI, dashboards), use
172172
`ocr review --format json --audience agent`. The viewer renders for

pages/src/content/docs/index.ts

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/* Docs content index — imports all markdown files and provides a lookup by slug + language */
22

33
// English docs
4-
import enOverview from './en/overview.md';
54
import enQuickstart from './en/quickstart.md';
65
import enInstallation from './en/installation.md';
76
import enConfiguration from './en/configuration.md';
@@ -20,7 +19,6 @@ import enContributing from './en/contributing.md';
2019
import enFaq from './en/faq.md';
2120

2221
// Chinese docs
23-
import zhOverview from './zh/overview.md';
2422
import zhQuickstart from './zh/quickstart.md';
2523
import zhInstallation from './zh/installation.md';
2624
import zhConfiguration from './zh/configuration.md';
@@ -39,7 +37,6 @@ import zhContributing from './zh/contributing.md';
3937
import zhFaq from './zh/faq.md';
4038

4139
// Japanese docs
42-
import jaOverview from './ja/overview.md';
4340
import jaQuickstart from './ja/quickstart.md';
4441
import jaInstallation from './ja/installation.md';
4542
import jaConfiguration from './ja/configuration.md';
@@ -58,7 +55,6 @@ import jaContributing from './ja/contributing.md';
5855
import jaFaq from './ja/faq.md';
5956

6057
export type DocSlug =
61-
| 'overview'
6258
| 'quickstart'
6359
| 'installation'
6460
| 'configuration'
@@ -77,7 +73,6 @@ export type DocSlug =
7773
| 'faq';
7874

7975
const enDocs: Record<DocSlug, string> = {
80-
'overview': enOverview,
8176
'quickstart': enQuickstart,
8277
'installation': enInstallation,
8378
'configuration': enConfiguration,
@@ -97,7 +92,6 @@ const enDocs: Record<DocSlug, string> = {
9792
};
9893

9994
const zhDocs: Record<DocSlug, string> = {
100-
'overview': zhOverview,
10195
'quickstart': zhQuickstart,
10296
'installation': zhInstallation,
10397
'configuration': zhConfiguration,
@@ -117,7 +111,6 @@ const zhDocs: Record<DocSlug, string> = {
117111
};
118112

119113
const jaDocs: Record<DocSlug, string> = {
120-
'overview': jaOverview,
121114
'quickstart': jaQuickstart,
122115
'installation': jaInstallation,
123116
'configuration': jaConfiguration,

pages/src/content/docs/ja/overview.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

pages/src/content/docs/ja/viewer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ JSONL トランスクリプトには、LLM に送信され LLM から受信し
139139
OpenTelemetry exporter は別の話です——prompt の内容をエクスポートされる trace に含めない方法については
140140
[テレメトリ](../telemetry/)を参照してください。
141141

142-
## ビューアが*適さない*場合
142+
## ビューアが適さない場合
143143

144144
- プログラムによる後処理(CI、ダッシュボード)には `ocr review --format json --audience agent` を使用します。
145145
ビューアは人間向けのレンダリングであり、機械向けではありません。

pages/src/content/docs/zh/overview.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

pages/src/content/docs/zh/viewer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ JSONL 转录包含发给 LLM 和从 LLM 收到的**一切**,包括 diff 中的
139139
OpenTelemetry exporter 是另一回事——如何让 prompt 内容不进入导出 trace 见
140140
[遥测](../telemetry/)
141141

142-
## 查看器**适用时
142+
## 查看器不适用时
143143

144144
- 程序化后处理(CI、仪表盘)用 `ocr review --format json --audience agent`
145145
查看器为人渲染,不为机器。

pages/src/i18n/en.ts

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -100,23 +100,13 @@ export const en: TranslationKeys = {
100100

101101
// Docs Page (keep existing)
102102
'docs.toc': 'Table of Contents',
103-
'docs.overview': 'Overview',
104103
'docs.install': 'Install',
105104
'docs.config': 'ocr config',
106105
'docs.review': 'ocr review',
107106
'docs.scan': 'ocr scan',
108107
'docs.viewer': 'ocr viewer',
109108
'docs.mcp': 'MCP Server',
110109
'docs.env': 'Claude Code Integration',
111-
'docs.overviewTitle': 'Overview',
112-
'docs.overviewDesc': '(short <code>ocr</code>) is an AI-powered code review CLI tool.',
113-
'docs.overviewFeatures': 'Core Features:',
114-
'docs.overviewFeat1': 'Supports workspace, branch diff, single-commit, and full scan review modes',
115-
'docs.overviewFeat2': 'Built-in Anthropic, OpenAI, DashScope, DeepSeek, Z.AI and custom provider support',
116-
'docs.overviewFeat3': 'Concurrent review with customizable timeouts',
117-
'docs.overviewFeat4': 'Output format supports text and json',
118-
'docs.overviewFeat5': 'Zero config for Claude Code users',
119-
'docs.overviewFeat6': 'WebUI viewer for visualizing review results',
120110
'docs.installTitle': 'Install',
121111
'docs.installLabel': 'Install',
122112
'docs.installVerifyLabel': 'Verify Installation',
@@ -269,7 +259,6 @@ export const en: TranslationKeys = {
269259
// Docs Sidebar
270260
'docs.sidebar.gettingStarted': 'Getting Started',
271261
'docs.sidebar.userGuide': 'User Guide',
272-
'docs.sidebar.overview': 'Overview',
273262
'docs.sidebar.quickstart': 'QuickStart',
274263
'docs.sidebar.installation': 'Installation',
275264
'docs.sidebar.configuration': 'Configuration',

0 commit comments

Comments
 (0)