Skip to content

Comments

Mindtrace Documentation Pipeline [1/2]#255

Merged
vik-rant merged 14 commits intodevfrom
feature/docmentation
Nov 11, 2025
Merged

Mindtrace Documentation Pipeline [1/2]#255
vik-rant merged 14 commits intodevfrom
feature/docmentation

Conversation

@pankhuri-mt
Copy link
Collaborator

@pankhuri-mt pankhuri-mt commented Nov 4, 2025

This PR introduces an initial documentation system for the Mindtrace project using MkDocs Material with automated multi-version deployment via GitHub Actions. It adds following:

  • Landing Page (docs/index.md)
  • Symlinked READMEs for modules
  • Auto-generated API docs for each module using mkdocstrings
  • Added Mindtrace logo
  • Fixed broken internal links to GitHub URLs in core/README.md and services/README.md
  • mkdocs yaml with:
    • Material theme with customizable dark/light mode
    • Navigation structure with tabs, sections, and search
    • Emoji support
    • Mermaid diagram support
    • Admonitions and collapsible details
    • Added docs dependency group
  • Automated deployment strategy (.github/workflows/docs.yml)
    • Mike Integration:
      • mike manages multiple documentation versions in the gh-pages branch
      • Each version gets its own subdirectory (e.g., /dev/, /v1.0.0/, /latest/)
      • Provides a version selector dropdown in the deployed docs
      • Maintains version history without overwriting previous releases

Note: The upcoming PR will prioritise strengthening the documentation content and refining docstring formatting to enhance clarity and Python readability.
For review purposes, Github Page available at : https://mindtrace.github.io/mindtrace/feature-docs/

@vik-rant vik-rant merged commit a7fa5de into dev Nov 11, 2025
4 checks passed
@vik-rant vik-rant deleted the feature/docmentation branch November 11, 2025 16:50
@vik-rant vik-rant added documentation Improvements or additions to documentation mindtrace-core Issues raised from core module in mindtrace package labels Nov 12, 2025
@vik-rant vik-rant linked an issue Nov 12, 2025 that may be closed by this pull request
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 mindtrace-core Issues raised from core module in mindtrace package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] Docs pipeline

2 participants