Refactor README structure and remove outdated sections

Removed sections on lessons learned, docs, and IDE comparisons. Updated headings for experience and workflows.
This commit is contained in:
Shayan Rais
2026-01-28 11:52:48 +05:00
committed by GitHub
parent 372ad2b71b
commit 9c4515960d
+3 -23
View File
@@ -18,10 +18,7 @@ your best ai assistant with the best practice
**Extension Overview:** See [Extend Claude Code](https://code.claude.com/docs/en/features-overview) for when to use each feature and how they layer together.
## LESSON LEARNED
### My Experience
## MY EXPERIENCE
**Workflows**
- Claude.md should not exceed 150+ lines. (still not 100% guarenteed)
@@ -48,11 +45,11 @@ your best ai assistant with the best practice
- use mcp (claude in chrome, playwright, chrome dev tool) to let claude see chrome console logs on its own
- provide screenshots of the issue
### Context Engineering
CONTEXT ENGINEERING
- [Humanlayer - Writing a good Claude.md](https://www.humanlayer.dev/blog/writing-a-good-claude-md)
- [Claude.md for larger monorepos - Boris Cherny on X](https://github.com/shanraisshan/claude-code-best-practice/blob/main/reports/claude-md-for-larger-mono-repos.md)
### Workflows
## WORKFLOWS
- [Ralph plugin with sandbox](https://www.youtube.com/watch?v=eAtvoGlpeRU)
- [Human Layer RPI - Research Plan Implement](https://github.com/humanlayer/advanced-context-engineering-for-coding-agents/blob/main/ace-fca.md)
- [AgentOs - 2026 its overkill (Brian Casel)](https://www.youtube.com/watch?v=0hdFJA-ho3c)
@@ -96,20 +93,3 @@ your best ai assistant with the best practice
## SECURITY
- [Great talk at 39C3 on "Agentic ProbLLMs: Exploiting AI Computer-Use and Coding Agents"](https://www.reddit.com/r/cybersecurity/comments/1qannih/great_talk_at_39c3_on_agentic_probllms_exploiting/)
## DOCS
### **[docs/AGENTS.md](docs/AGENTS.md)** - Agent Orchestration Best Practices
Learn how to properly orchestrate multiple agents, avoid common pitfalls when sub-agents aren't invoking, and implement sequential workflows using the Task tool.
### **[docs/PROMPTS.md](docs/PROMPTS.md)** - Invocation Patterns Reference
Quick reference tables showing how to invoke agents and commands from different contexts (CLI, other agents, other commands).
### **[docs/WEATHER.md](docs/WEATHER.md)** - Weather System Flow Documentation
Complete system architecture and flow diagram for the weather data fetching and transformation workflow, demonstrating real-world agent and command orchestration.
## IDE
### Cursor vs. Windsurf vs. VS Code
[Claude Code Replaced Cursor for Me… Heres Why](https://www.youtube.com/watch?v=0iGEpx8IeM0)
![](!/ide.png)