Skip to content

Migration to v1.2.0

Steps to migrate from v1.1.5 to v1.2.0. Documentation moves from doc/ into src/doc/ so it stays in your IDE workspace.

Move doc folder under src

Moves documentation (doc/) into the source tree (src/doc/).

Why:

  • Developers open src/ in their IDE for daily work.
  • doc/ at repo root meant switching folders when editing code + docs.
  • doc/ inside src/ keeps everything in one workspace.
  • Repo root only has infrequently-changed files (README, .github/, etc.).
  • Coding tools scoped to src/ miss doc/ at repo root.

Update .github/workflows/deploy-mkdocs.yml

    push:
      branches: [main]
      paths:
-       - "doc/mkdocs.yml"
-       - "doc/docs/**"
+       - "src/doc/mkdocs.yml"
+       - "src/doc/docs/**"
    pull_request:
      branches: [main]
      paths:
-       - "doc/mkdocs.yml"
-       - "doc/docs/**"
+       - "src/doc/mkdocs.yml"
+       - "src/doc/docs/**"

    - name: Deploy MkDocs
      uses: Reloaded-Project/devops-mkdocs@v1
      with:
-       requirements: ./doc/docs/requirements.txt
+       requirements: ./src/doc/docs/requirements.txt
        publish-to-pages: ${{ github.event_name == 'push' }}
        checkout-current-repo: true
-       config-file: ./doc/mkdocs.yml
+       config-file: ./src/doc/mkdocs.yml

Move files

Move the entire doc/ directory tree into src/:

doc/                          →  src/doc/
doc/.gitignore                →  src/doc/.gitignore
doc/.vscode/settings.json     →  src/doc/.vscode/settings.json
doc/start_docs.py             →  src/doc/start_docs.py
doc/mkdocs.yml                →  src/doc/mkdocs.yml
doc/docs/...                  →  src/doc/docs/...

No content changes needed inside the moved files. start_docs.py uses Path(__file__).parent which remains correct. VSCode setting exclusions for venv/ and __pycache__/ use relative paths and remain valid.

Update the template version marker

Update .github/template-version.txt to reflect the new version:

- reloaded-templates-rust:1.1.5
+ reloaded-templates-rust:1.2.0