developer README's now appears in the documentation

Author: neoneye

.github/workflows/deploy.yml

@@ -41,10 +41,17 @@ jobs:
       - name: Build documentation
         run: |
           # Copy docs from PlanExe repo
-          # Create docs directory and copy files
           mkdir -p docs
           cp -r planexe-source/docs/* docs/
           
+          # Copy component READMEs into docs/developer/ so they are part of the built docs
+          mkdir -p docs/developer
+          for component in open_dir_server worker_plan frontend_single_user database_postgres worker_plan_database frontend_multi_user mcp_local mcp_cloud; do
+            if [ -f "planexe-source/$component/README.md" ]; then
+              cp "planexe-source/$component/README.md" "docs/developer/${component}.md"
+            fi
+          done
+          
           # Build with mkdocs
           mkdocs build --site-dir site
       

build.py

@@ -77,6 +77,30 @@ def main():
         )
         shutil.copytree(docs_source_path, docs_dir, dirs_exist_ok=True)
 
+        # Copy component READMEs into docs/developer/ so they are part of the built docs
+        developer_dir = docs_dir / "developer"
+        developer_dir.mkdir(exist_ok=True)
+        component_readmes = [
+            ("open_dir_server", "README.md"),
+            ("worker_plan", "README.md"),
+            ("frontend_single_user", "README.md"),
+            ("database_postgres", "README.md"),
+            ("worker_plan_database", "README.md"),
+            ("frontend_multi_user", "README.md"),
+            ("mcp_local", "README.md"),
+            ("mcp_cloud", "README.md"),
+        ]
+        for component, readme_name in component_readmes:
+            src = planexe_repo / component / readme_name
+            dst = developer_dir / f"{component}.md"
+            if src.exists():
+                shutil.copy2(src, dst)
+            else:
+                print_colored(
+                    f"Warning: {src} not found, skipping for docs",
+                    YELLOW
+                )
+        
         # Copy mkdocs.yml to temp directory
         shutil.copy2(mkdocs_yml, temp_docs_path / "mkdocs.yml")
 

mkdocs.yml

@@ -10,6 +10,15 @@ nav:
   - Getting started:
     - Getting started with PlanExe: getting_started.md
     - Developer install: install_developer.md
+    - Developer components:
+      - open_dir_server: developer/open_dir_server.md
+      - worker_plan: developer/worker_plan.md
+      - frontend_single_user: developer/frontend_single_user.md
+      - database_postgres: developer/database_postgres.md
+      - worker_plan_database: developer/worker_plan_database.md
+      - frontend_multi_user: developer/frontend_multi_user.md
+      - mcp_local: developer/mcp_local.md
+      - mcp_cloud: developer/mcp_cloud.md
     - Docker: docker.md
   - AI providers:
     - OpenRouter: openrouter.md