8000 docs: error reference guide (#192) by adityamukho · Pull Request #278 · project-minigraf/minigraf · GitHub
[go: up one dir, main page]

Skip to content

docs: error reference guide (#192) - #278

Merged
adityamukho merged 11 commits into
mainfrom
feat/error-reference
May 19, 2026
Merged

adityamukho merged 11 commits into
mainfrom
feat/error-reference

Conversation

@adityamukho
Copy link
Copy Markdown
Collaborator

Summary

  • Adds docs/ERROR_REFERENCE.md with 113 user-facing error entries across five categories: PRS (parser), QRY (query execution), STG (storage), WAL (write-ahead log), API (database API)
  • Each entry has: error text, cause, resolution steps, and a bad-input example or scenario
  • Docs-only reference codes (PRS-001…API-009) are forward-compatible with runtime codes planned in post-1.0: add structured error codes to runtime output #277
  • Appendix lists 8 internal-error strings with instructions to file a bug

Test plan

🤖 Generated with Claude Code

@codecov
codecov Bot commented May 19, 2026
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@adityamukho
adityamukho merged commit b19fff4 into main May 19, 2026
15 checks passed
@adityamukho
adityamukho deleted the feat/error-reference branch May 19, 2026 11:11
@adityamukho adityamukho linked an issue May 19, 2026 that may be closed by this pull request
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.

post-1.0: write error message guide

1 participant

0