Skip to content

refactor(docs): migrate legacy Markdown files to MkDocs structure - #155

Merged
saudadez21 merged 2 commits into
mainfrom
feat/mkdocs-setup
Nov 30, 2025
Merged

refactor(docs): migrate legacy Markdown files to MkDocs structure#155
saudadez21 merged 2 commits into
mainfrom
feat/mkdocs-setup

Conversation

@saudadez21

Copy link
Copy Markdown
Owner

Description

This PR migrates the project's legacy Markdown documentation into a structured MkDocs setup.

It introduces a new mkdocs.yml configuration, organizes existing documentation into appropriate sections, and prepares the repository for automated deployment via GitHub Actions.


Changes

  • Converted old standalone .md files into MkDocs-compatible pages
  • Introduced mkdocs.yml configuration file
  • Added a new directory structure under docs/
  • Updated internal links and navigation
  • Integrated MkDocs Material theme
  • Added auto-deploy workflow for documentation (deploy_docs.yml)
  • Removed outdated or redundant Markdown files
  • Ensured all pages render correctly under MkDocs navigation

Motivation

The previous documentation consisted of scattered Markdown files without a unified structure.

Migrating to MkDocs improves:

  • readability
  • navigation
  • long-term maintainability

Type of change

  • Documentation update

Checklist

  • I have tested my changes locally
  • I have updated documentation if needed
  • Code follows the project's coding style

@saudadez21
saudadez21 merged commit bd41d58 into main Nov 30, 2025
1 check passed
@saudadez21
saudadez21 deleted the feat/mkdocs-setup branch November 30, 2025 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant