Skip to content

Commit 39b31ec

Browse files
ericyangpanclaude
andcommitted
docs: enhance README with comprehensive manifest contribution guide
- Add detailed Data Structure section explaining manifest organization - Include manifest file structure examples and validation guidelines - Add translation examples for multilingual support - Enhance feature list with Search & Discovery, Open Source Rankings, AI Coding Landscape, and Curated Collections - Update language support from 2 to 4 languages (English, German, Simplified Chinese, Korean) - Improve project structure descriptions with more context - Add reference to CONTRIBUTING.md for detailed guidelines 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 74edba9 commit 39b31ec

File tree

1 file changed

+93
-6
lines changed

1 file changed

+93
-6
lines changed

README.md

Lines changed: 93 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,105 @@ AI Coding Stack is a comprehensive directory and community-maintained metadata r
1616

1717
## Features
1818

19-
- **Comprehensive Directory**: Browse and discover AI coding tools across multiple categories (IDEs, CLIs, models, and providers)
19+
- **Comprehensive Directory**: Browse and discover AI coding tools across multiple categories (IDEs, CLIs, Extensions, Models, Providers, and Vendors)
2020
- **Smart Comparison**: Compare tools side-by-side with detailed specifications and pricing
21+
- **Search & Discovery**: Powerful search functionality to find the right tools for your needs
22+
- **Open Source Rankings**: Track and compare GitHub stars and community engagement
23+
- **AI Coding Landscape**: Visual overview of the entire AI coding ecosystem
24+
- **Curated Collections**: Hand-picked tool collections for specific use cases
2125
- **Community-Driven**: Open-source metadata maintained by the developer community
2226
- **Always Updated**: Latest version tracking and up-to-date information
23-
- **Multilingual**: Support for English and Simplified Chinese (more coming soon)
27+
- **Multilingual**: Support for English, German, Simplified Chinese, and Korean (more coming soon)
28+
29+
## Data Structure
30+
31+
All metadata for AI coding tools is organized in JSON manifest files within the `manifests/` directory. Each tool, model, or platform has its own manifest file following a structured schema.
32+
33+
### Adding or Updating Metadata
34+
35+
To add a new tool or update existing information:
36+
37+
1. **Find the right category**: Locate the appropriate directory in `manifests/`
38+
2. **Add or update a JSON file**: Create a new manifest file or edit an existing one
39+
3. **Follow the schema**: Each category has a JSON schema for validation
40+
4. **Submit a PR**: Open a pull request with your changes
41+
42+
### Manifest Categories
43+
44+
All metadata is stored as JSON files in the `manifests/` directory:
45+
46+
- **IDEs** (`manifests/ides/`) - AI-powered integrated development environments
47+
- Example: Cursor, Windsurf, VS Code with AI features
48+
- **CLIs** (`manifests/clis/`) - Command-line AI coding assistants
49+
- Example: Claude Code CLI, Codex, GitHub Copilot CLI
50+
- **Extensions** (`manifests/extensions/`) - AI code assistant plugins and extensions
51+
- Example: GitHub Copilot, Cline, Continue, Roo Code
52+
- **Models** (`manifests/models/`) - Large language models for coding
53+
- Example: GPT-4, Claude Opus, DeepSeek V3, Qwen3 Coder
54+
- **Providers** (`manifests/providers/`) - LLM API providers and platforms
55+
- Example: OpenAI, Anthropic, DeepSeek, OpenRouter, SiliconFlow
56+
- **Vendors** (`manifests/vendors/`) - Companies and organizations behind the tools
57+
58+
### Manifest File Structure
59+
60+
Each manifest file is a JSON object following a specific schema. Here's a basic example for a CLI tool:
61+
62+
```json
63+
{
64+
"$schema": "../$schemas/cli.schema.json",
65+
"id": "tool-id",
66+
"name": "Tool Name",
67+
"description": "Brief description of the tool",
68+
"websiteUrl": "https://example.com",
69+
"docsUrl": "https://docs.example.com",
70+
"vendor": "Vendor Name",
71+
"latestVersion": "1.0.0",
72+
"githubUrl": "https://github.com/vendor/tool",
73+
"translations": {
74+
"de": {
75+
"description": "Kurze Beschreibung des Tools"
76+
}
77+
}
78+
}
79+
```
80+
81+
### Adding Translations
82+
83+
You can add multilingual support by including a `translations` field:
84+
85+
```json
86+
{
87+
"description": "English description",
88+
"translations": {
89+
"de": {
90+
"description": "Deutsche Beschreibung"
91+
},
92+
"zh-Hans": {
93+
"description": "简体中文描述"
94+
},
95+
"ko": {
96+
"description": "한국어 설명"
97+
}
98+
}
99+
}
100+
```
101+
102+
### Validation
103+
104+
All manifest files are automatically validated against JSON schemas. Make sure your JSON:
105+
- Follows the schema for the category
106+
- Has valid URLs (HTTPS only)
107+
- Includes all required fields
108+
- Is properly formatted
24109

25110
## Project Structure
26111

27-
- `manifests/` - JSON metadata files for all tools and platforms
28-
- `content/` - MDX documentation, guides, and articles
29-
- `src/` - Next.js 15 application source code
112+
- `manifests/` - **JSON metadata files** for all tools and platforms (this is where you contribute!)
113+
- `content/` - MDX documentation, guides, articles, and FAQs (multilingual)
114+
- `src/` - Next.js application source code
30115
- `public/` - Static assets and resources
116+
- `scripts/` - Validation and data processing scripts
117+
- `translations/` - i18n translation files for all supported languages
31118

32119
## Tech Stack
33120

@@ -39,7 +126,7 @@ AI Coding Stack is a comprehensive directory and community-maintained metadata r
39126

40127
## Contributing
41128

42-
We welcome contributions! Please check the manifest files in `manifests/` to add or update tool information.
129+
We welcome contributions! Please check the manifest files in `manifests/` to add or update tool information. See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines and schema references.
43130

44131
## Contact
45132

0 commit comments

Comments
 (0)