charieswei
/
vibe-coding-cn
mirror of https://github.com/tukuaiai/vibe-coding-cn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update en/ README files to match actual directory structure 

- Update README.md directory structure section
- Update mermaid diagram paths
- Update documents/README.md to match actual folders
- Fix prompts path references
This commit is contained in:
tukuaiai 2025-12-19 17:19:51 +08:00
parent 828505a2f1
commit 805892ea49
4 changed files with 100 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
i18n/en/README.md
View File

@ -350,23 +350,36 @@ The core structure of this `vibe-coding-cn` project primarily revolves around kn
│ └── XHS-image-to-PDF-conversion/ # Xiaohongshu image to PDF conversion tool. │ └── XHS-image-to-PDF-conversion/ # Xiaohongshu image to PDF conversion tool.
│ │
├── i18n/en/prompts/ # Centralized storage for all types of AI prompts. ├── i18n/en/prompts/ # Centralized storage for all types of AI prompts.
│ ├── 00-meta-prompts/ # Auxiliary prompts. │ ├── 00-meta-prompts/ # Meta prompts (prompts that generate prompts)
│ ├── 02-coding-prompts/ # Prompt collection specifically for programming and code generation. │ ├── 01-system-prompts/ # AI system-level prompts for behavior and framework
│ │ └── ... (specific coding prompt files) │ │ └── ... (system prompts)
│ │ │ │
│ ├── 01-system-prompts/ # AI system-level prompts, used to set AI behavior and framework. │ ├── 02-coding-prompts/ # Prompts for programming and code generation
│ │ └── ... (other system prompts) │ │ └── ... (coding prompt files)
│ │ │ │
│ └── 03-user-prompts/ # User-defined or commonly used prompts. │ └── 03-user-prompts/ # User-defined or commonly used prompts
│ ├── ASCII Art Generation.md # ASCII art generation prompts. │ └── ... (user prompts)
│ ├── Data Pipeline.md # Data pipeline processing prompts.
│ └── ... (other user prompts)
│ │
├── i18n/en/skills/ # Centralized storage for all types of skills. ├── i18n/en/skills/ # Centralized storage for all types of skills.
├── claude-skills # Meta-skill for generating SKILLS ├── 00-meta-skills/ # Meta skills
│ ├── SKILL.md │ └── claude-skills/ # Skills generator
│ └── ... (others) ├── 01-ai-tools/ # AI CLI tools
└── ... (and other skills) │ ├── claude-code-guide/
│ └── claude-cookbooks/
├── 02-databases/ # Database skills
│ ├── postgresql/
│ └── timescaledb/
├── 03-crypto/ # Cryptocurrency/quantitative
│ ├── ccxt/
│ ├── coingecko/
│ ├── cryptofeed/
│ ├── hummingbot/
│ └── polymarket/
└── 04-dev-tools/ # Development tools
├── telegram-dev/
├── twscrape/
├── snapdom/
└── proxychains/
``` ```
--- ---
@ -384,10 +397,10 @@ In one sentence: Vibe Coding = **Planning-driven + Context-fixed + AI Pair Execu
Core Asset Mapping: Core Asset Mapping:
``` ```
i18n/en/prompts/ i18n/en/prompts/
02-coding-prompts/ # Core prompts for demand clarification, planning, and execution chain. 00-meta-prompts/ # Meta prompts for generating prompts
01-system-prompts/ # System-level prompts constraining AI behavior. 01-system-prompts/ # System-level prompts constraining AI behavior
00-meta-prompts/ # Auxiliary/cooperative prompts. 02-coding-prompts/ # Core prompts for demand clarification, planning, and execution
03-user-prompts/ # Reusable user-side prompts. 03-user-prompts/ # Reusable user-side prompts
i18n/en/documents/ i18n/en/documents/
Templates and Resources/Code Organization.md, Templates and Resources/General Project Architecture Template.md, Methodology and Principles/Development Experience.md, Methodology and Principles/System Prompt Construction Principles.md, and other knowledge bases. Templates and Resources/Code Organization.md, Templates and Resources/General Project Architecture Template.md, Methodology and Principles/Development Experience.md, Methodology and Principles/System Prompt Construction Principles.md, and other knowledge bases.
backups/ backups/
@ -432,10 +445,10 @@ graph TB
end end
subgraph consume_layer[Execution and Consumption Layer] subgraph consume_layer[Execution and Consumption Layer]
artifacts_md --> catalog_coding[i18n/en/prompts/coding_prompts] artifacts_md --> catalog_coding[i18n/en/prompts/02-coding-prompts]
artifacts_md --> catalog_system[i18n/en/prompts/system_prompts] artifacts_md --> catalog_system[i18n/en/prompts/01-system-prompts]
artifacts_md --> catalog_assist[i18n/en/prompts/assistant_prompts] artifacts_md --> catalog_meta[i18n/en/prompts/00-meta-prompts]
artifacts_md --> catalog_user[i18n/en/prompts/user_prompts] artifacts_md --> catalog_user[i18n/en/prompts/03-user-prompts]
artifacts_md --> docs_repo[i18n/en/documents/*] artifacts_md --> docs_repo[i18n/en/documents/*]
artifacts_md --> new_consumer[Reserved: Other Downstream Channels] artifacts_md --> new_consumer[Reserved: Other Downstream Channels]
catalog_coding --> ai_flow[AI Pair Programming Workflow] catalog_coding --> ai_flow[AI Pair Programming Workflow]

0
i18n/en/documents/.gitkeep
View File

160
i18n/en/documents/README.md
View File

@ -1,123 +1,95 @@
# 📖 Documents # 📖 Documents
The `i18n/zh/documents/` directory aggregates project process documentation, architectural descriptions, development experience, and best practices, serving as the primary entry point for understanding methodologies and collaboration rules. > Documentation library for Vibe Coding methodology, guides, and resources
## Directory Structure ---
## 📁 Directory Structure
``` ```
i18n/en/documents/ documents/
├── README.md ├── 00-fundamentals/ # Core concepts & principles
│ ├── Glue Coding.md
│ ├── Language Layer Elements.md
│ ├── Common Pitfalls.md
│ ├── The Way of Programming.md
│ ├── Development Experience.md
│ ├── System Prompt Construction Principles.md
│ ├── A Formalization of Recursive Self-Optimizing Generative Systems.md
│ ├── General Project Architecture Template.md
│ └── Code Organization.md
│ │
├── Starting Vibe Coding from Scratch/ # 🚀 Must-read for beginners ├── 01-getting-started/ # Getting started guides
│ ├── 00-Vibe Coding Philosophy.md │ ├── 00-Vibe Coding Philosophy.md
│ ├── 01-Network Environment Configuration.md │ ├── 01-Network Environment Configuration.md
│ ├── 02-Development Environment Setup.md │ ├── 02-Development Environment Setup.md
│ └── 03-IDE Configuration.md │ └── 03-IDE Configuration.md
│ │
├── Glue Coding/ # 🧬 Revolutionary Paradigm of Glue Coding ├── 02-methodology/ # Methodology & best practices
│ └── README.md
│
├── Methodology and Principles/
│ ├── A Formalization of Recursive Self-Optimizing Generative Systems.md
│ ├── gluecoding.md
│ ├── vibe-coding-experience-collection.md
│ ├── Learning Experience.md
│ ├── Development Experience.md
│ ├── The Way of Programming.md
│ └── System Prompt Construction Principles.md
│
├── Tutorials and Guides/
│ ├── auggie-mcp Configuration Document.md │ ├── auggie-mcp Configuration Document.md
│ ├── LazyVim Shortcut Cheatsheet.md │ ├── LazyVim Shortcut Cheatsheet.md
│ ├── tmux Shortcut Cheatsheet.md │ ├── tmux Shortcut Cheatsheet.md
│ └── How to SSH to Local Computer from Any Location via FRP.md │ ├── vibe-coding-experience-collection.md
│ └── How to SSH to Local Computer from Any Location via Mobile, Based on FRP Implementation.md
│ │
├── Templates and Resources/ ├── 03-practice/ # Practical examples
│ ├── Code Organization.md │ ├── telegram-dev/
│ ├── Tool Collection.md │ ├── polymarket-dev/
│ ├── Recommended Programming Books.md │ └── web-app/
│ ├── General Project Architecture Template.md
│ └── memory-bank-template/
│ │
├── External Resource Aggregation/ # 🔗 External Links Summary └── 04-resources/ # Tools & resources
│ ├── AI Tools and Platforms/ ├── External Resource Aggregation.md
│ ├── GitHub Featured Repositories/ ├── Tool Collection.md
│ ├── Prompt Resources/ └── Recommended Programming Books.md
│ ├── Development Tools/
│ ├── Tutorials and Courses/
│ └── Communities and Forums/
│
└── Project Practical Experience/ # 📁 Case Studies
├── fate-engine-dev/
├── polymarket-dev/
├── telegram-dev/
└── ...
``` ```
## Document Categories ---
### 🚀 Starting Vibe Coding from Scratch (Beginner's Guide) ## 🗂️ Categories
Completely new? Start here! ### 00-fundamentals
Core concepts and methodology:
- **Glue Coding** - Revolutionary programming paradigm
- **Language Layer Elements** - 12-layer framework
- **Common Pitfalls** - Avoid common mistakes
- **The Way of Programming** - Dao · Fa · Shu philosophy
- **Development Experience** - Best practices
- **System Prompt Construction Principles** - Prompt engineering
* [00-Vibe Coding Philosophy](./Starting%20Vibe%20Coding%20from%20Scratch/00-Vibe%20Coding%20Philosophy.md) - Core Concepts ### 01-getting-started
* [01-Network Environment Configuration](./Starting%20Vibe%20Coding%20from%20Scratch/01-Network%20Environment%20Configuration.md) - Configure network access Beginner's guide:
* [02-Development Environment Setup](./Starting%20Vibe%20Coding%20from%20Scratch/02-Development%20Environment%20Setup.md) - Set up development environment (Prompt Version) - **00-Vibe Coding Philosophy** - Core concepts
* [03-IDE Configuration](./Starting%20Vibe%20Coding%20from%20Scratch/03-IDE%20Configuration.md) - Configure VS Code / Cursor / Windsurf - **01-Network Environment Configuration** - Network setup
- **02-Development Environment Setup** - Dev environment
- **03-IDE Configuration** - VS Code / Cursor setup
### 🧬 Glue Coding ### 02-methodology
Tools and tutorials:
- **auggie-mcp Configuration** - Augment MCP setup
- **LazyVim Shortcut Cheatsheet** - Vim shortcuts
- **tmux Shortcut Cheatsheet** - Terminal multiplexer
- **FRP Remote Development** - Mobile SSH access
**The Holy Grail and Silver Bullet of Software Engineering.** Completely solves Vibe Coding's hallucination, complexity, and barrier issues. ### 03-practice
Real project examples:
- **telegram-dev/** - Telegram bot development
- **polymarket-dev/** - Polymarket data analysis
- **web-app/** - Web application examples
* [Introduction to Glue Coding](./Glue%20Coding/README.md) - Revolutionary Programming Paradigm ### 04-resources
Tools and external resources:
- **External Resource Aggregation** - Curated links
- **Tool Collection** - Recommended tools
- **Recommended Programming Books** - Book list
### Methodologies and Principles ---
Documents on programming philosophy, development principles, and core project guidelines. ## 🔗 Related Resources
* `A Formalization of Recursive Self-Optimizing Generative Systems.md` - Formalization of Recursive Self-Optimizing Systems - [Prompts Library](../prompts/)
* `gluecoding.md` - Glue Coding Theory - [Skills Library](../skills/)
* `vibe-coding-experience-collection.md` - Experience Summary - [Main README](../../../README.md)
* `Learning Experience.md` - Learning Insights
* `Development Experience.md` - Development Practices
* `The Way of Programming.md` - Programming Philosophy
* `System Prompt Construction Principles.md` - Prompt Engineering
### Tutorials and Guides ---
Configuration, usage guides, and operational tutorials for specific tools. [← Back](../README.md)
* `auggie-mcp Configuration Document.md` - Augment MCP Configuration
* `LazyVim Shortcut Cheatsheet.md` - LazyVim Shortcuts
* `tmux Shortcut Cheatsheet.md` - tmux Shortcuts
* `How to SSH to Local Computer from Any Location via FRP.md` - Remote Development
### Templates and Resources
Reusable project templates, code structure specifications, and resource lists.
* `Code Organization.md` - Code Organization Standards
* `Tool Collection.md` - Tool Recommendations
* `Recommended Programming Books.md` - Book Recommendations
* `General Project Architecture Template.md` - Project Templates
* `memory-bank-template/` - Memory Bank Template
### 🔗 External Resource Aggregation
Summary of high-quality external resources, continuously updated.
* [External Resource Aggregation](./External%20Resource%20Aggregation/README.md) - General Index
### 📁 Project Practical Experience
Summaries of experience and case studies from actual project development.
* [Project Practical Experience](./Project%20Practical%20Experience/README.md) - General Index
* `fate-engine-dev/` - Fate Engine Development
* `polymarket-dev/` - Polymarket Data Analysis
* `telegram-dev/` - Telegram Bot Development
## Related Resources
- [Prompt Library](../prompts/) - AI Prompt Collection
- [Skill Library](../skills/) - AI Skills

0
i18n/en/skills/.gitkeep
View File