Skip to content

Decide tracking policy for docs/deployment-guide.md #50

Description

@Simplemart17

Context

Surfaced by Acceptance Auditor on PR #48 (story 9-9, finding D12 / A1).

Concern

Story 9-9 AC #7 said "replace the App Store Submission section in docs/deployment-guide.md with a runbook pointer." The edit was made on disk, but docs/deployment-guide.md is gitignored by the existing docs/* rule (carve-outs only for docs/tcf-spec-source.md and docs/tcf-spec-source.pdf), so the change lives only in the operator's workspace and is not committed.

Tracked artifacts (CLAUDE.md, SUBMISSION_CHECKLIST.md, supabase/README.md) all carry the runbook pointer, so contributors find the runbook through those — the operator-local edit is redundant for discoverability.

Decision needed

Pick one:

  1. Keep operator-local — leave the gitignore rule alone; docs/deployment-guide.md remains an operator-local artifact (current state).
  2. Track it — add !docs/deployment-guide.md to .gitignore, commit the current content as a new tracked file. Pro: contributors see the doc in clone; con: another tracked doc to keep in sync with the runbook.
  3. Delete it — if it's redundant with the runbook + CLAUDE.md, removing it eliminates a future drift surface.

Files

  • .gitignore:62-66
  • docs/deployment-guide.md (operator-local)

Pull request: #48

Metadata

Metadata

Assignees

No one assigned

    Labels

    tech-debtFollow-up work surfaced by code review or audit; not a current bug

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions