Skip to content

docs: clarify package readmes#20

Merged
jb-thery merged 1 commit into
mainfrom
docs/package-readme-context
Jun 28, 2026
Merged

docs: clarify package readmes#20
jb-thery merged 1 commit into
mainfrom
docs/package-readme-context

Conversation

@jb-thery

Copy link
Copy Markdown
Member

Summary

  • make each package README sufficiently descriptive for npm while keeping the root README canonical
  • explain what @jcode.labs/mimir does, what it is for, and how to start quickly
  • explain what @jcode.labs/mimir-tts does, its offline and Edge TTS paths, and how to start quickly
  • fix the synthetic demo README path from the repository root
  • prepare version 0.4.4 so npm can display the updated package READMEs after publish

Validation

  • pnpm validate
  • git diff --check
  • inspected generated 0.4.4 tarballs for @jcode.labs/mimir and @jcode.labs/mimir-tts README content
  • inspected generated @jcode.labs/mimir tarball for the corrected sovereign-rag-demo README path

@jb-thery jb-thery merged commit 3271294 into main Jun 28, 2026
5 checks passed
@jb-thery jb-thery deleted the docs/package-readme-context branch June 28, 2026 19:20
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