chore: clean up obsolete docs and align remaining files with defineErrors v2#102
Merged
chore: clean up obsolete docs and align remaining files with defineErrors v2#102
Conversation
Replace stale TaggedError imports, mapError/mapErr params, and context/cause nesting with defineErrors, catch, and flat error fields across docs, naming convention, and launch specs.
Both files were historical drafts entirely built on the old createTaggedError/TaggedError API. All their content is covered by the current README.md with correct defineErrors patterns.
Remove nextjs-app-router.mdx (1,193 lines, ~20% wellcrafted-specific) and nodejs-express.mdx (1,329 lines, ~15% wellcrafted-specific) — both were generic framework tutorials with anti-patterns and fabricated tests. Focused replacements can be written from scratch later. Remove completed internal spec (brand-docs-validation-guide.md). Fix mapError → catch in implementation.mdx code example.
braden-w
force-pushed
the
chore/docs-cleanup
branch
from
8cca3ca to
442f8cb
Compare
braden-w
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #101 (defineErrors v2). This cleans up documentation that was either obsolete or still referencing the old
createTaggedErrorAPI after the v2 migration.Two large files —
README_OG.md(865 lines) andREADME_MD.md(1,081 lines) — were historical drafts built entirely on the old API, now fully superseded by the currentREADME.md. Two integration guides —nextjs-app-router.mdx(~1,194 lines) andnodejs-express.mdx(~1,330 lines) — were generic framework tutorials with minimal wellcrafted-specific content and fabricated test examples; focused replacements can be written from scratch when needed.The remaining changes update stale
TaggedErrorimports,mapError→catchreferences, andcontext/causenesting patterns acrossNAMING_CONVENTION.md, the launch specs, andeffect-comparison.mdto usedefineErrors/InferError/InferErrorsconsistently.