A modern, searchable knowledge base built with MkDocs Material containing software engineering knowledge, tips, and best practices.
Organized by area of interest, with a focus on machine learning and AI:
- Machine Learning & AI: The math and models behind ML — core specialty
- Python: Language tips, idioms, and gotchas
- Web Development: Flask guides and tutorials
- DevOps & Tools: Git commands, configurations, and workflows
- Roadmap: A competency matrix tracking progress toward Senior
- Troubleshooting: Real problems hit and how they got fixed
- And more, as new areas come up!
- 🔍 Full-text search across all content
- 🏷️ Tag-based organization for easy discovery
- 📱 Mobile-friendly responsive design
- 🌙 Dark/light mode toggle
- 🚀 Fast loading with modern web technologies
-
Clone the repository:
git clone https://github.com/igormcsouza/knowledge-base.git cd knowledge-base -
Install dependencies:
uv sync
-
Start the development server:
uv run mkdocs serve
-
Open your browser to
http://127.0.0.1:8000
Want to add content? Check out the Contributing guide to learn how to:
- Decide where a new topic belongs (or create a new category)
- Add new pages and articles
- Use tags effectively
- Follow content guidelines
- Preview changes locally
The site is automatically deployed to GitHub Pages via GitHub Actions when changes are merged to the main branch.
