Skip to content

fix(docs): address issue #826 documentation gaps (D1, D3-D6)

Jérôme Revillard requested to merge fix/826-doc-fixes into main

Summary

Fixes from issue #826 (closed) — AI-Driven Deployment documentation gaps.

Item Fix
D1 AGENTS.md symlinks → CLAUDE.md in all 6 directories (root, _bmad/bmad-issue-tracking, components/gov-chat-frontend, genie-ai-overlay, mobile/genie_ai_mobile, mobile/genie_ai_mobile/patrol_test) for cross-platform AI agent discoverability
D2 Fixed separately — cherry-picked 02d5c9561 to main (deploy.yml writes resolved compose to separate file)
D3 Fix CLAUDE.md quick start paths (missing inventory/ prefix, non-existent test.vault.example, wrong vault creation command)
D4 Add SSH Key Setup section to README, DEPLOY_OPEA warning box, fix email_password vault entry (user registration, not always), update nginx_permissions_policy troubleshooting
D5 Add commented ansible_ssh_private_key_file to inventory.example
D6 Add nginx_permissions_policy default to all.yml
D7 Skipped — AGENTS.md is the cross-platform standard, no need for .cursorrules/.windsurfrules

Files changed

  • AGENTS.md (new symlink → CLAUDE.md)
  • _bmad/bmad-issue-tracking/AGENTS.md (new symlink → CLAUDE.md)
  • components/gov-chat-frontend/AGENTS.md (new symlink → CLAUDE.md)
  • genie-ai-overlay/AGENTS.md (new symlink → CLAUDE.md)
  • mobile/genie_ai_mobile/AGENTS.md (new symlink → CLAUDE.md)
  • mobile/genie_ai_mobile/patrol_test/AGENTS.md (new symlink → CLAUDE.md)
  • CLAUDE.md (fix Ansible quick start paths)
  • deploy/ansible/README.md (SSH setup, DEPLOY_OPEA warning, email_password, troubleshooting)
  • deploy/ansible/group_vars/all.yml (nginx_permissions_policy default)
  • deploy/ansible/inventory/inventory.example (ansible_ssh_private_key_file)

Closes #826 (closed)

Edited by Jérôme Revillard

Merge request reports

Loading