Remove Dead and Obsolete Code and Add Documentation Update Checks for the Manage Service

[gibahjoe]

Summary

Clean up the Manage service by removing unused or obsolete code and introduce a GitHub Actions check to ensure documentation is updated alongside code changes. This will improve maintainability and keep documentation aligned with current functionality.

Main Tasks

1. Remove Dead Code

Review the repository and remove unused code, including:

• Unused modules, functions, classes, and imports
• Duplicate or outdated implementations
• Obsolete feature flags and integrations
• Unused scripts, middleware, templates, and endpoints
• Redundant tests, configs, and dependencies

Confirm code is not used elsewhere before removal. If uncertain, document and raise a follow-up task.

2. Update Documentation

Update relevant files in the docs/ folder to reflect changes:

docs/
├── add-data/
├── assign-entities/
└── other-user-processes/

Remove or update references to deleted or changed functionality.

3. Add Documentation Check

Create a GitHub Actions workflow that:

• Runs on pull requests
• Fails if code changes without corresponding updates in docs/
• Provides a clear failure message
• Supports an approved exemption label (e.g. docs-not-required)
• Ignores documentation-only or non-functional changes

Acceptance Criteria

Code Clean-up

• Unused code, configs, and dependencies are removed
• No impact on existing functionality
• Tests and linting pass
• Risky removals are tracked separately

Documentation

• Docs reflect current codebase
• Outdated references are removed
• Structure remains organised by user process

GitHub Actions Check

• Workflow runs on pull requests
• Detects code and documentation changes
• Fails when docs are missing
• Supports visible, approved exemptions
• Tested and documented
• Configured as a required check where appropriate

[gibahjoe]

Possible check

# .github/workflows/check-docs-updated.yml
name: Check documentation updated

on:
  pull_request:

permissions:
  contents: read

jobs:
  check-docs:
    runs-on: ubuntu-latest

    steps:
      - name: Check out repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Check whether documentation was updated
        env:
          BASE_SHA: ${{ github.event.pull_request.base.sha }}
          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
        run: |
          changed_files="$(git diff --name-only "$BASE_SHA" "$HEAD_SHA")"

          echo "Changed files:"
          echo "$changed_files"

          code_changed=false
          docs_changed=false

          while IFS= read -r file; do
            case "$file" in
              docs/*)
                docs_changed=true
                ;;
              *.py|*.js|*.ts|*.tsx|*.java|*.go|*.rb|*.cs|*.php|src/*|app/*)
                code_changed=true
                ;;
            esac
          done <<< "$changed_files"

          if [[ "$code_changed" == "true" && "$docs_changed" != "true" ]]; then
            echo "::error::Service code changed, but no files under docs/ were updated."
            echo "Update the relevant user-process documentation, or apply the agreed exemption."
            exit 1
          fi

          echo "Documentation check passed."