Run a documentation-only goal
A documentation-only goal is the simplest kind of bounded goal: it adds content and tooling without modifying production code.
When to use
- You are writing or extending the docs portal.
- You are adding a new docs section.
- You are fixing a typo or broken link.
- You are updating diagrams.
Steps
- Create a new branch:
git checkout -b feature/docs-<bounded-scope>. - Copy
goals/ASF50_DOCS_PORTAL_001/GOAL_RECORD.yamlas a template. - Update the contract:
goal_id,goal_type: DOCUMENTATION_PORTAL,phase_id,current_state: READY_FOR_PLAN,required_role: PLANNER,tasks,allowed_paths,forbidden_paths,acceptance_gates,evidence_requirements,owner_gates. - Write the
CONTEXT.yamlandPROMPT.md. - Commit the goal contract (no other changes in this commit).
- Run
goal-run.ps1 -GoalId <NEW_GOAL_ID> -RuntimeRoot … -DryRun -StopAtOwnerGate. - Inspect the JSON. The orchestrator should report
current_state: READY_FOR_PLAN,next_state: READY_FOR_PLAN,next_role: PLANNER,next_task_ids: [<T01-PLAN>]. - Edit the docs files in
docs-site/. - Run
npm install(or skip if node_modules is already present). - Run
npm run buildto validate. - Run
npm run startto spot-check locally (optional). - Run a broken-link checker (e.g.,
linkinator). - Run the docs security audit (
scripts/check-docs-build.ps1). - Commit the docs changes in the same branch.
- Push the branch.
- Open the PR.
- STOP at the GitHub review boundary.
What the orchestrator emits
After the bounded commit, goal-run.ps1 re-runs without -DryRun. The orchestrator may emit:
MERGE_APPROVALat the PR head → owner submits an approving review.PRODUCTION_PROMOTIONafter the merge → owner signs a production ticket.
What this playbook is NOT
- It is not for production code changes.
- It is not for governance changes.
- It is not for repository-wide refactors.