Skip to content

Comments

This commit adds MkDocs to the project for documentation generation.#19

Merged
gowthamrao merged 1 commit intodevelopfrom
feat-add-mkdocs-documentation
Oct 26, 2025
Merged

This commit adds MkDocs to the project for documentation generation.#19
gowthamrao merged 1 commit intodevelopfrom
feat-add-mkdocs-documentation

Conversation

@gowthamrao
Copy link
Contributor

  • Adds mkdocs and mkdocs-material as development dependencies.
  • Creates a mkdocs.yml configuration file.
  • Creates an initial docs/index.md file.
  • Updates .gitignore to exclude the site/ directory.
  • Adds a build-docs job to the CI/CD pipeline to build the documentation.

- Adds mkdocs and mkdocs-material as development dependencies.
- Creates a mkdocs.yml configuration file.
- Creates an initial docs/index.md file.
- Updates .gitignore to exclude the site/ directory.
- Adds a build-docs job to the CI/CD pipeline to build the documentation.
@codecov
Copy link

codecov bot commented Oct 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@gowthamrao gowthamrao merged commit 3d96672 into develop Oct 26, 2025
13 checks passed
@gowthamrao gowthamrao deleted the feat-add-mkdocs-documentation branch October 26, 2025 00:50
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