Skip to content

docs: add quickstart and troubleshooting docs#4

Merged
stuft2 merged 7 commits intomainfrom
codex/quickstart-troubleshooting-docs
Feb 13, 2026
Merged

docs: add quickstart and troubleshooting docs#4
stuft2 merged 7 commits intomainfrom
codex/quickstart-troubleshooting-docs

Conversation

@stuft2
Copy link
Owner

@stuft2 stuft2 commented Feb 13, 2026

Summary

  • add a new Quickstart (1 minute) section near the top of the README with a copy/paste local success path and optional Vault example
  • add a Troubleshooting section using symptom -> cause -> fix entries mapped to real runtime/CLI error strings
  • document precedence behavior with an explicit example (existing env wins)
  • add a verbose-mode safety note and link the feature in the roadmap
  • update Taskfile quality-gate commands for golangci-lint v2 and sandbox-safe caches

Test evidence

  • task fmt (pass)
  • task lint (pass, 0 issues)
  • task test (pass)

Risk / rollback

  • Risk is low: changes are docs + task automation config only (no runtime code paths changed).
  • Rollback: revert commit 903b602 or close this PR without merging.

@stuft2 stuft2 merged commit f94a0b4 into main Feb 13, 2026
4 checks passed
@stuft2 stuft2 deleted the codex/quickstart-troubleshooting-docs branch February 13, 2026 06:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant