Skip to content

Conversation

@amrit110
Copy link
Member

This pull request introduces significant improvements to documentation, developer workflow automation, and project configuration for the AI Engineering Platform. The most notable changes are the addition of comprehensive documentation (including a new user guide and an overview), the setup of automated GitHub Actions workflows for code checks and documentation deployment, and enhancements to the MkDocs configuration and theming for a more professional and branded documentation site.

Documentation Enhancements:

  • Added a detailed project overview, architecture diagrams, usage instructions, and requirements to both README.md and the new documentation homepage docs/index.md. This provides clear guidance for both administrators and participants. [1] [2]
  • Created a new user guide at docs/user_guide.md to support end users.

Automation and CI/CD:

  • Introduced .github/workflows/code_checks.yml to automate code linting, dependency checks, and security auditing on pushes and pull requests.
  • Added .github/workflows/docs.yml to build and deploy documentation to GitHub Pages automatically, including artifact handling and deployment steps.

MkDocs Documentation Site Improvements:

  • Significantly expanded mkdocs.yml with navigation, plugins (including mkdocstrings for API documentation), social links, theming, and color palette customization to match the Vector Institute branding.
  • Added custom CSS in docs/stylesheets/extra.css and custom partials in docs/overrides/partials/ to enhance the look and feel of the documentation, including branded logos and responsive footer design. [1] [2] [3]

Developer Tooling:

  • Updated the ruff-pre-commit hook in .pre-commit-config.yaml to a newer version for improved Python linting.

These changes collectively make the project easier to use, contribute to, and deploy, while also improving its visual identity and maintainability.

@amrit110 amrit110 self-assigned this Oct 31, 2025
@amrit110 amrit110 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 31, 2025
@amrit110 amrit110 merged commit b76eb54 into main Oct 31, 2025
3 checks passed
@amrit110 amrit110 deleted the add_docs branch October 31, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants