use a symlink for the mkdocs.yaml file so changes are auto applied

Author: ms-lolo

rats-devtools/src/rats/docs/_app.py

@@ -77,7 +77,8 @@ def _do_mkdocs_things(self, cmd: str) -> None:
         mkdocs_config = docs_component.find_path("mkdocs.yaml")
         mkdocs_staging_path = docs_component.find_path("dist/docs")
         site_dir_path = docs_component.find_path("dist/site")
-        mkdocs_staging_config = docs_component.find_path("dist/mkdocs.yaml")
+        # we append the filename because symlinks get resolved by `find_path()`
+        mkdocs_staging_config = docs_component.find_path("dist") / "mkdocs.yaml"
         # clear any stale state
         docs_component.create_or_empty(mkdocs_staging_path)
         # start with the contents of our root-docs
@@ -91,7 +92,7 @@ def _do_mkdocs_things(self, cmd: str) -> None:
 
         # replace the mkdocs config with a fresh version
         mkdocs_staging_config.unlink(missing_ok=True)
-        docs_component.copy(mkdocs_config, mkdocs_staging_config)
+        docs_component.symlink(mkdocs_config, mkdocs_staging_config)
 
         args = [
             "--config-file",