Add docs using mkdocs #11
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
README.mdand the new documentation homepagedocs/index.md. This provides clear guidance for both administrators and participants. [1] [2]docs/user_guide.mdto support end users.Automation and CI/CD:
.github/workflows/code_checks.ymlto automate code linting, dependency checks, and security auditing on pushes and pull requests..github/workflows/docs.ymlto build and deploy documentation to GitHub Pages automatically, including artifact handling and deployment steps.MkDocs Documentation Site Improvements:
mkdocs.ymlwith navigation, plugins (including mkdocstrings for API documentation), social links, theming, and color palette customization to match the Vector Institute branding.docs/stylesheets/extra.cssand custom partials indocs/overrides/partials/to enhance the look and feel of the documentation, including branded logos and responsive footer design. [1] [2] [3]Developer Tooling:
ruff-pre-commithook in.pre-commit-config.yamlto 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.