How yogeshsingh-11/generative-ai-for-beginners works
Main Components
• Repository Infrastructure – Represent elements that support development and collaboration:
• Dev Environment & Configuration: Include the .devcontainer folder (with Setup.txt, devcontainer.json, environment.yml, post-create.sh) and .vscode settings.
• Meta-level Documents: Items like LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, and overall README.
• Lesson 00 – Course Setup: Contains setup instructions, translations, and auxiliary materials.
• A README file (explaining the lesson content and instructions)
• Code samples and assets (images, notebooks, scripts)
• Language-specific subdirectories (python, javascript/typescript, dotnet) that provide code examples for different ecosystems.
• Translation Support: Note that many folders have parallel “translations” directories (for cn, es-mx, ja-jp, ko, pt-br, tw, etc.) so include a node for “Localization/Translations” that links to many lesson modules.
• External Integrations:
Relationships and Interactions
– Lesson Content (README with text explanations and images)
– Code samples (organized under language-specific folders)
– Translations (linking to localization components)
Architectural Patterns & Design Principles
• Separation of Concerns: Indicate how translations, code samples, and documentation are separated into their own directories.
• Extensibility: Note that with multiple language examples and extensive documentation, the repository is designed to be easily forked, extended, and repurposed by learners.
• Integration Points: Clearly mark the external service integrations, showing how the course teaches interacting with APIs (for instance, Azure OpenAI Service, OpenAI API calls, etc.).
Technology & Frameworks
• Within the lessons, include annotations or labels identifying used technologies when relevant:
– Python (as seen in multiple lesson folders with prerequisites, notebooks, assignment scripts)
– TypeScript/JavaScript (e.g., for assignments in lessons 05, 07, 08, 09, 11)
– .NET components (in some lessons, particularly where there are .NET subdirectories)
– GitHub Actions and dev containers for development environment configuration.
Essential Elements
• Clear labels for every major component: “Repository Infrastructure,” “Course Lessons,” “Localization,” “External AI Services,” etc.
– Show the flow from the centralized development & configuration that supports all lessons.
– Illustrate data flow (or instructional flow) between each lesson and external APIs (for build lessons).
– Represent how translations are linked to each lesson.
• Annotations: Briefly note in each component what its purpose is (for example: “Lesson 04 – Prompt Engineering” includes code examples in Python and translation support; “06 - Text Generation Apps” integrates with Azure OpenAI and OpenAI API).