Replaced security considerations with an overview of the API Rate Limiter project, detailing its features, algorithms, and importance in preventing attacks.
- Add learn/ folder as required for all new projects
- Add detailed section 4 explaining learn/ folder structure
- List all 5 required files with descriptions
- Add quality standards for educational documentation
- Update PR template with learn/ folder checklist
- Include verification steps using template files
- Increase time estimates for intermediate (2-4d, 3-5d) and advanced (1w, 1-2w, 2-3w, 3-4w) projects
This ensures all future projects have consistent, high quality
educational documentation that teaches security concepts.
- Add comprehensive 5-file template structure
- 00-OVERVIEW.md: Project intro, quick start, prerequisites
- 01-CONCEPTS.md: Security concepts with real world examples
- 02-ARCHITECTURE.md: System design and technical decisions
- 03-IMPLEMENTATION.md: Code walkthrough with actual examples
- 04-CHALLENGES.md: Extension ideas from easy to expert
- README.md: Template usage guide and writing guidelines
- CHECKLIST.md: Quick reference for filling templates
Writing guidelines emphasize:
- Human voice (avoiding AI patterns like em dashes, contrast flips)
- Concrete examples over abstractions
- Real code references with file:line numbers
- Real world incidents and vulnerabilities
- Practical, actionable content
- Converted all 60 projects to compact table format with inline badges
- Added time estimate badges, tech stack badges, and difficulty indicators
- Added "What You'll Learn" sections with key concepts
- Updated completed projects to show "Source Code | Docs" links
- Diversified programming languages across all difficulty levels:
- Beginner: Added C++, Go, and Bash projects
- Intermediate: Added Go and Rust projects
- Advanced: Added Go, Rust, and C++ projects
- Maintained existing tech stack badges (Docker, AWS, Azure, CUDA, etc.)
- Convert all 60 projects to compact table format
- Add time estimate badges for each project
- Add tech stack badges with colored logos
- Add difficulty level badges (Beginner/Intermediate/Advanced)
- Add 'What You'll Learn' section with key concepts
- Improve visual presentation and scannability
- Maintain all existing project links and descriptions
- Update working-directory from PROJECTS/fastapi-420 to PROJECTS/advanced/api-rate-limiter
- Update packages-dir to match new project location
- Fixes workflow failure from missing directory
- Keep header and badges section intact
- Simplify to Quick Navigation with 3 main sections
- Keep all 60 projects in clean bulleted format
- Replace verbose Roadmaps section with single link
- Replace verbose Resources section with single link
- Reduce from 294 lines to 129 lines
- Focus on showcasing projects with clear entry points
- Create RESOURCES/README.md as entry point
- Create RESOURCES/TOOLS.md with cybersecurity tools
- Create RESOURCES/COURSES.md with training platforms
- Create RESOURCES/CERTIFICATIONS.md with exam prep
- Create RESOURCES/COMMUNITIES.md with YouTube, Reddit, LinkedIn
- Create RESOURCES/FRAMEWORKS.md with security frameworks
- Update main README to link to RESOURCES/
- Reduce main README by ~420 lines
Carter Perez
CarterPerez-dev