Skip to content

Commit 292a3db

Browse files
ericyangpanclaude
andcommitted
docs: update documentation for new schema
Update all documentation to reflect the new model schema structure. - Update getting-started guides across all locales (en, de, ko, zh-Hans) - Update schema documentation (SCHEMA-ALIGNMENT, SCHEMA-ARCHITECTURE, SCHEMA-REFACTORING-SUMMARY) - Update SEO audit report - Update GitHub setup manual - Update contributing guide with new schema field names 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 51f772b commit 292a3db

File tree

10 files changed

+19
-23
lines changed

10 files changed

+19
-23
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Create a file in `manifests/models/your-model.json`:
152152
"id": "your-model",
153153
"vendor": "Your Company",
154154
"size": "175B",
155-
"totalContext": 128000,
155+
"contextWindow": 128000,
156156
"maxOutput": 4096,
157157
"pricing": {
158158
"input": 0.01,
@@ -179,7 +179,7 @@ Create a file in `manifests/models/your-model.json`:
179179

180180
#### Model-Specific Fields
181181
- **`size`**: Model size (e.g., "175B", "70B")
182-
- **`totalContext`**: Total context window in tokens
182+
- **`contextWindow`**: Total context window in tokens
183183
- **`maxOutput`**: Maximum output tokens
184184
- **`pricing`**: Pricing information object
185185

content/docs/de/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Alle Tool-Metadaten werden in JSON-Dateien im Verzeichnis `manifests/` gespeiche
6464
"vendor": "Vendor",
6565
"id": "model-id",
6666
"size": "70B",
67-
"totalContext": 128000,
67+
"contextWindow": 128000,
6868
"maxOutput": 4096,
6969
"pricing": {...},
7070
"urls": {...}

content/docs/en/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ All tool metadata is stored in JSON files under the `manifests/` directory:
6464
"vendor": "Vendor",
6565
"id": "model-id",
6666
"size": "70B",
67-
"totalContext": 128000,
67+
"contextWindow": 128000,
6868
"maxOutput": 4096,
6969
"pricing": {...},
7070
"urls": {...}

content/docs/ko/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ AI Coding Stack은 커뮤니티에서 유지 관리됩니다. 매니페스트
6464
"vendor": "벤더",
6565
"id": "model-id",
6666
"size": "70B",
67-
"totalContext": 128000,
67+
"contextWindow": 128000,
6868
"maxOutput": 4096,
6969
"pricing": {...},
7070
"urls": {...}

content/docs/zh-Hans/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ AI Coding Stack 由社区维护。你可以通过在我们的清单文件中添
6464
"vendor": "供应商",
6565
"id": "model-id",
6666
"size": "70B",
67-
"totalContext": 128000,
67+
"contextWindow": 128000,
6868
"maxOutput": 4096,
6969
"pricing": {...},
7070
"urls": {...}

docs/GITHUB_SETUP_MANUAL_STEPS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@ If you don't want to use an organization:
107107
- **Status checks to require** (select these after first CI run):
108108
- `lint`
109109
- `type-check`
110-
- `validate-manifests`
111-
- `validate-urls`
110+
- `test:validate`
111+
- `test:urls`
112112
- `spell-check`
113113
- `build`
114114
- `ci-success` (optional, aggregates all checks)
@@ -498,8 +498,8 @@ Now let's commit all changes and test the setup:
498498
- You should now see these checks available:
499499
- `lint`
500500
- `type-check`
501-
- `validate-manifests`
502-
- `validate-urls`
501+
- `test:validate`
502+
- `test:urls`
503503
- `spell-check`
504504
- `build`
505505
- `ci-success`

docs/SCHEMA-ALIGNMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ specific schemas (clis.schema.json, ides.schema.json, etc.)
234234
"description": "License (e.g., 'MIT', 'Apache-2.0', 'Proprietary')"
235235
},
236236
"size": "...",
237-
"totalContext": "...",
237+
"contextWindow": "...",
238238
"maxOutput": "...",
239239
"pricing": {
240240
"type": "object",

docs/SCHEMA-ARCHITECTURE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ entity.schema.json (Base Entity)
3434
│ │
3535
│ ├── models.schema.json (AI Models)
3636
│ │ ├── Adds: latestVersion (nullable), githubUrl (nullable), githubStars (nullable)
37-
│ │ │ size, totalContext, maxOutput, tokenPricing, platformUrls
38-
│ │ └── Required: size, totalContext, maxOutput, tokenPricing, platformUrls
37+
│ │ │ size, contextWindow, maxOutput, tokenPricing, platformUrls
38+
│ │ └── Required: size, contextWindow, maxOutput, tokenPricing, platformUrls
3939
│ │
4040
│ ├── providers.schema.json (Model Providers)
4141
│ │ ├── Adds: latestVersion (nullable), githubUrl (nullable, required), githubStars (nullable, required)
@@ -171,15 +171,15 @@ collections.schema.json (Independent)
171171
- `githubUrl` (string/null, uri, github.com): Repository (optional)
172172
- `githubStars` (number/null, ≥0): Stars (optional)
173173
- `size` (string): Parameter size (e.g., "7B", "200B")
174-
- `totalContext` (string): Context window (e.g., "128K")
175-
- `maxOutput` (string): Max output tokens (e.g., "4K")
174+
- `contextWindow` (number): Context window in tokens (e.g., 128000)
175+
- `maxOutput` (number): Max output tokens (e.g., 4096)
176176
- `tokenPricing` (object): API pricing
177177
- `input` (string): Input pricing
178178
- `output` (string): Output pricing
179179
- `cache` (string/null): Cache pricing
180180
- `platformUrls` (object, → platform-urls.schema.json): Third-party platforms
181181

182-
**Required**: `size`, `totalContext`, `maxOutput`, `tokenPricing`, `platformUrls`
182+
**Required**: `size`, `contextWindow`, `maxOutput`, `tokenPricing`, `platformUrls`
183183

184184
---
185185

docs/SCHEMA-REFACTORING-SUMMARY.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,9 @@ This document summarizes the schema refactoring work done to improve the design
9696
- Added top-level `installCommand` and `launchCommand` as optional fields (legacy support, prefer platform-specific values)
9797
- Added `relatedProducts` support to `app.schema.json`
9898

99-
### 7. Updated Validation Script
99+
### 7. Schema Loading Order
100100

101-
**Problem**: The validation script didn't know about the new `vendor-entity.schema.json`.
102-
103-
**Solution**:
104-
- Updated `scripts/validate-manifests.mjs` to load `vendor-entity.schema.json` in the correct order (after `entity`, before `product`)
101+
**Note**: The validation tests in `tests/validate/` load `vendor-entity.schema.json` in the correct order (after `entity`, before `product`)
105102

106103
## Benefits
107104

@@ -148,7 +145,6 @@ All manifest files now pass validation:
148145
### Code Files
149146
- `src/app/[locale]models/[slug]/page.tsx`
150147
- `src/app/[locale]models/page.tsx`
151-
- `scripts/validate-manifests.mjs`
152148

153149
## Recommendations for Future
154150

docs/SEO-AUDIT-REPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ title: "AI Coding Stack - Comprehensive Directory of AI Coding Tools, Models & P
203203
title: `${ide.name} - AI-Powered IDE | Features, Pricing & Documentation 2025`
204204

205205
// Model detail pages
206-
title: `${model.name} - ${model.size} LLM for Coding | ${model.totalContext} Context Window`
206+
title: `${model.name} - ${model.size} LLM for Coding | ${model.contextWindow} Context Window`
207207

208208
// List pages
209209
title: "Best AI-Powered IDEs 2025 | Visual Studio Code, Cursor, TRAE - AI Coding Stack"

0 commit comments

Comments
 (0)