Skip to content

Docs - #10

Merged
AldhairMedico merged 3 commits into
vgl-hub:mainfrom
DanielGarbozo:docs
Jul 30, 2026
Merged

Docs#10
AldhairMedico merged 3 commits into
vgl-hub:mainfrom
DanielGarbozo:docs

Conversation

@DanielGarbozo

Copy link
Copy Markdown
Contributor

This pull request sets up documentation building and hosting with MkDocs and Read the Docs, and improves the maintainability and usability of the documentation. The main changes include adding configuration files for Read the Docs and MkDocs, updating documentation dependencies, and refactoring internal links for better compatibility with the documentation site.

Documentation build and hosting setup:

  • Added .readthedocs.yaml to configure Read the Docs builds, specifying the OS, Python version, and requirements file for building the docs (.readthedocs.yaml).
  • Added mkdocs.yml to configure the MkDocs documentation site, including theme, navigation, plugins, and repository links (mkdocs.yml).
  • Added docs/requirements.txt to specify documentation build dependencies (mkdocs-material, mkdocs-include-markdown-plugin) (docs/requirements.txt).

Documentation content improvements:

  • Created docs/index.md to reuse the repository README.md as the documentation homepage, ensuring a single source of truth (docs/index.md).
  • Updated all documentation files to use [Back to README](index.md) for internal navigation instead of relative paths, improving compatibility with the MkDocs site (multiple files). [1] [2] [3] [4] [5] [6] [7] [8] [9]

Link and navigation fixes:

  • Updated links to the validation format documentation in README.md and docs/testing.md to point to the GitHub location, ensuring they work from both the docs site and repository (README.md, docs/testing.md). [1] [2]

@AldhairMedico
AldhairMedico merged commit c06dc1a into vgl-hub:main Jul 30, 2026
6 checks passed
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.

2 participants