docs: refactor into user and developer docs

cli/src/core/models.py

@@ -16,7 +16,7 @@ MASTER_SERVICE_DIR = REPO_ROOT / "services" / "master" / "current"
 MASTER_SERVICE_CONFIG_DIR = MASTER_SERVICE_DIR / "app" / "config"
 MASTER_HLA_NAMES_FILENAME = MASTER_SERVICE_CONFIG_DIR / "hla_names.yml"
 
-IOCS_OVERVIEW_FILENAME = REPO_ROOT / "docs" / "ioc" / "ioc_overview.md"
+IOCS_OVERVIEW_FILENAME = REPO_ROOT / "docs" / "ioc" / "user" / "ioc_overview.md"
 
 SERVICE_MANAGER_UI_FILENAME = REPO_ROOT / "qt" / "A_BD_ServiceManager.ui"
 

cli/src/core/service_creator.py

@@ -85,7 +85,7 @@ class ServiceCreator:
                 "config/services_registry.yml",
                 "services/master/current/app/config/hla_names.yml",
                 "services/master/current/ioc/AGEBD-CPCL-MASTER_main.subs",
-                "docs/ioc/ioc_overview.md",
+                "docs/ioc/user/ioc_overview.md",
                 "qt/A_BD_ServiceManager.ui",
             ]
             # TODO: can't push if branch already exists in remote
@@ -189,7 +189,7 @@ class ServiceCreator:
             files_to_stage = [
                 f"services/{service.dir_name}/current",
                 # "config/services_registry.yml",
-                "docs/ioc/ioc_overview.md",
+                "docs/ioc/user/ioc_overview.md",
             ]
             # TODO: can't push if branch already exists in remote
             git_push_changes(

cli/src/service.py

@@ -21,7 +21,10 @@ def add(
     ),
     user: str = typer.Option(..., "--user", "-u", help="PSI username of the owner of the service"),
     ioc_description: str = typer.Option(
-        ..., "--ioc-description", "-d", help="See <repo-root>/docs/ioc/ioc_overview.md for examples"
+        ...,
+        "--ioc-description",
+        "-d",
+        help="See <repo-root>/docs/user/ioc/ioc_overview.md for examples",
     ),
     ui_name: str = typer.Option(
         ...,
@@ -52,7 +55,10 @@ def migrate(
     name: str = typer.Option(..., "--name", "-n"),
     user: str = typer.Option(..., "--user", "-u"),
     ioc_description: str = typer.Option(
-        ..., "--ioc-description", "-d", help="See <repo-root>/docs/ioc/ioc_overview.md for examples"
+        ...,
+        "--ioc-description",
+        "-d",
+        help="See <repo-root>/docs/user/ioc/ioc_overview.md for examples",
     ),
     ui_filename: str = typer.Option(
         ...,

docs/user/ioc/ioc_overview.md

@@ -1,6 +1,6 @@
 # Overview of IOCs for Beam Dynamics
 
-The ports are configured in the [service registry](../../config/services_registry.yml)
+The ports are configured in the [service registry](../../../config/services_registry.yml)
 
 | IOC NAME | Description |
 |---|---|