Skip to content

docs: sync markdown with DDD v5/v6 and auth implementation#71

Merged
pourdaavar merged 1 commit into
mainfrom
docs/markdown-sync
Jul 4, 2026
Merged

docs: sync markdown with DDD v5/v6 and auth implementation#71
pourdaavar merged 1 commit into
mainfrom
docs/markdown-sync

Conversation

@pourdaavar

Copy link
Copy Markdown
Contributor

Summary

  • Sync @rineex/ddd README with v5/v6 API (Result union, registry-backed DomainError, Result.ok() void overload, layer contract)
  • Fix root README anchors, project tree, VO list, prerequisites, and add documentation map
  • Rewrite auth-core design docs to match implemented model; preserve aspirational spec in FUTURE.md
  • Update domain errors/VOs READMEs for v6 registry pattern (no type field)
  • Fix passwordless docs for Result v5 API; add OTP README; cross-link pg-slonik docs

Closes #70

Test plan

  • Pre-commit hooks pass (prettier, cspell)
  • Manual link-check: root README → ddd README anchors
  • Spot-read public exports vs packages/ddd/src/index.ts and packages/authentication/core/src/index.ts
  • Grep confirms no stale Result.fail or error.type in user-facing docs

Made with Cursor

Align user-facing READMEs and guides with recent Result union,
registry-backed DomainError, and actual auth-core code. Rewrite
aspirational auth design docs to match implementation; preserve
target-state spec in FUTURE.md.

Closes #70

Co-authored-by: Cursor <cursoragent@cursor.com>
@changeset-bot

changeset-bot Bot commented Jul 4, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 8dd273b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pourdaavar pourdaavar merged commit fb2b848 into main Jul 4, 2026
5 checks passed
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.

docs: sync markdown documentation with DDD v5/v6 and auth implementation

1 participant