Documentation Commit Push

2. README Documentation

• Include a ## Documentation Summary section in README.md.
• Document the changes made in the most recent commit or push.
• Keep the summary short, clear, and linked to the relevant files.
• Preserve any existing README content outside of the generated section.

3. Wiki Architecture Documentation

• Store architecture docs in wiki/architecture.md.
• Use DDD concepts: domain, application, infrastructure, and integration boundaries.
• Describe how MLOps flows are implemented: experiment tracking, model deployment, monitoring, and retraining.
• Include Mermaid diagrams for:
  • class diagrams / domain model
  • component diagrams
  • execution/workflow diagrams

4. Mermaid Diagram Requirements

• Use mermaid fenced code blocks in Markdown.
• Generate at least one UML-style diagram for domain relationships.
• Generate at least one execution or flow diagram for runtime behavior.
• Keep diagrams aligned to the code structure and system boundaries.

5. Best Practices for Code Documentation

• Document the purpose of each major package or module.
• Describe how domain entities, services, and infrastructure interact.
• Keep architecture documentation at a high level, with links to source files when useful.
• Keep generated documentation in source control.

Example project layout

project-root/
  README.md
  settings/
    environment.yml
  src/
    domain/
    application/
    infrastructure/
  tests/
    unit/
      domain/
      infrastructure/
    integration/
      application/
  scripts/
    generate_documentation_commit_push.py
  wiki/
    architecture.md

Recommended execution

• Run python scripts/generate_documentation_commit_push.py --commit-message "Update docs and push" --push before pushing changes.
• In CI, run the same script to refresh docs and verify the generated content.
• If using Git hooks, install the script as a pre-push helper.
• Ensure the Conda environment is activated (conda activate genai-course) before running the script.

Notes

• The documentation should reflect the actual code base and recent changes.
• Keep architecture documentation updated with every major refactor.
• Use the README summary as the quick entry point for contributors.