docs(fp): sync packages/fp/README.md with the restructured root README - #388
Merged
Conversation
added 2 commits
August 4, 2026 13:13
The npm-published package reads its README from packages/fp/README.md, not from the root README. Until this commit, the package README was the old user-facing README (description, install, quick start, then a series of per-API sections). The root README was restructured in #387 to align with the deessejs org template. This commit replaces packages/fp/README.md with a copy of the newly restructured root README, so npm consumers see the same coherent structure as GitHub visitors. Why copy rather than symlink: - npm does not honor symlinks in the published tarball. - The published README must be a real file. - A copy is the canonical idiomatic approach for monorepos that publish a single package from a multi-package root. Side effect: the package README is now slightly redundant with the root README (both reference the monorepo's publishing pipeline, project structure, etc.). This is acceptable for now; a future improvement could split the content into a 'repo overview' (root) and a 'package API' (file inside packages/fp/). No code changes. Documentation only.
Three small improvements to packages/fp/package.json that make the npm listing more discoverable and more accurate: 1. **Keywords expanded** (5 -> 13). Added: try, unit, pipe, flow, error-handling, async, monorepo, deessejs. The README references these concepts but the keywords array did not list them. 2. **bugs field** added. Explicit URL to the issue tracker (defaults to repository.url + /issues but the explicit form is more reliable) and support email. Renders as a 'Report vulnerabilities' link on npm. 3. **peerDependenciesMeta[@deessejs/errors].optional** set to true. The README and the install snippet already document @deessejs/errors as optional, but the npm metadata did not surface this. With this flag, npm advertises the peer dependency as optional at install time. No code changes. Documentation / metadata only.
martyy-code
pushed a commit
that referenced
this pull request
Aug 4, 2026
Patch bump to push the restructured README + enriched package metadata (keywords, bugs, peerDependenciesMeta) to npm. No code change. The version bump is needed because the release pipeline is PR-merge-driven and the prior merges #387 and #388 did not trigger it (their changesets were empty). The hotfix tag path is the fallback for this case.
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
2 participants
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.
Summary
The npm-published
@deessejs/fppackage reads its README frompackages/fp/README.md, not from the root README. Until this commit,packages/fp/README.mdwas the old user-facing README (description, install, quick start, then per-API sections). The root README was restructured in PR #387 to align with the deessejs org template.This PR replaces
packages/fp/README.mdwith a copy of the newly restructured root README, so npm consumers see the same coherent structure as GitHub visitors.Why copy rather than symlink
Trade-off
The package README is now slightly redundant with the root README (both reference the monorepo's publishing pipeline, project structure, etc.). This is acceptable for now. A future improvement could split the content into a 'repo overview' (root) and a 'package API' (file inside
packages/fp/).Test plan
pnpm turbo type-checkpasses.pnpm turbo lintpasses.https://www.npmjs.com/package/@deessejs/fpthat the README renders correctly.Risk
Very low. Documentation only. No code change, no behavior change.
Rollback
Revert the merge commit. The old
packages/fp/README.mdis preserved in git history.🤖 Generated with Claude Code