You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Complete the documentation set required for public beta: onboarding, verdict semantics, agent workflow, CLI, MCP, security, local data, capture, evaluation, troubleshooting, and compatibility guidance.
A new user should be able to install Gitworthy, connect it to an MCP host, run a bounded hunt, interpret every verdict and limitation, record an outcome, and recover from common failures without maintainer assistance.
Cursor, ChatGPT, Hermes, and generic MCP onboarding.
Correct scout versus execute model.
hunt as bounded per-candidate preflight rather than one global verdict.
ACT-as-queue semantics and mandatory recheck before implementation.
docs/AGENT_WORKFLOW.md with host-agent responsibilities, tool selection, ranking, dispositions, contribution paths, and outcome workflow.
Keep this issue open for the remaining beta documentation below.
Why this matters
Gitworthy's safety model depends on users and agents understanding what was checked, what was not checked, and what each next action permits. Missing or stale docs can turn a correct VERIFY result into an unsafe implementation decision.
Scope
Installation and clean-environment quickstart.
MCP setup and troubleshooting for Cursor plus at least two other hosts/harnesses.
CLI reference and practical examples aligned with GW-030.
MCP tool reference aligned with GW-032.
Verdict, disposition, evidence-strength, checked/not-checked, partial-run, and retry semantics.
Scout/execute workflow and contribution-path matrix.
Configuration/profile/target-manifest reference.
Local store, outcomes, capture, export, migration, rebuild, retention, and privacy guidance.
Frozen/live/private evaluation architecture and report interpretation.
Security model, hostile-input assumptions, token scope, redaction, and private disclosure.
Troubleshooting for auth scopes, rate limits, timeline visibility, npm/git failures, corrupt local data, stale decisions, and MCP stdio.
Compatibility/deprecation policy and version pinning guidance.
Contributor onboarding and calibration-case workflow.
Non-goals
No marketing claims not supported by released behavior.
No hosted SaaS documentation before such a product exists.
No duplicate hand-maintained command contract when generated reference can be used.
No instructions that encourage parsing human CLI output.
Documentation is part of the 1.0 contract. Examples should pin versions where reproducibility matters and must be updated in the same PR as any public command/tool/schema change.
Outcome
Complete the documentation set required for public beta: onboarding, verdict semantics, agent workflow, CLI, MCP, security, local data, capture, evaluation, troubleshooting, and compatibility guidance.
A new user should be able to install Gitworthy, connect it to an MCP host, run a bounded hunt, interpret every verdict and limitation, record an outcome, and recover from common failures without maintainer assistance.
Progress already delivered
PR #63 completed a meaningful first slice:
huntas bounded per-candidate preflight rather than one global verdict.docs/AGENT_WORKFLOW.mdwith host-agent responsibilities, tool selection, ranking, dispositions, contribution paths, and outcome workflow.Keep this issue open for the remaining beta documentation below.
Why this matters
Gitworthy's safety model depends on users and agents understanding what was checked, what was not checked, and what each next action permits. Missing or stale docs can turn a correct VERIFY result into an unsafe implementation decision.
Scope
Non-goals
Dependencies and readiness
Acceptance criteria
docs/.Tests and validation
Likely documentation map
README.md: product story and fast onboarding.docs/AGENT_WORKFLOW.md: scout/execute policy.docs/CLI.mdanddocs/MCP.md: reference and examples.docs/VERDICTS.md: decision semantics.docs/CONFIG.md: profiles and target manifests.docs/DATA.md: runs, decisions, outcomes, captures, migrations.docs/EVALS.md: suites, adjudication, and reports.docs/SECURITY_MODEL.md: hostile-input and credential boundaries.docs/TROUBLESHOOTING.md: doctor-driven remediation.Compatibility
Documentation is part of the 1.0 contract. Examples should pin versions where reproducibility matters and must be updated in the same PR as any public command/tool/schema change.