Skip to content

[codex] document npm README publishing#127

Merged
nahiyankhan merged 1 commit into
mainfrom
codex/npm-readme-docs
Jun 5, 2026
Merged

[codex] document npm README publishing#127
nahiyankhan merged 1 commit into
mainfrom
codex/npm-readme-docs

Conversation

@nahiyankhan
Copy link
Copy Markdown
Collaborator

Summary

  • Add a maintainer note to the npm-visible packages/ghost/README.md explaining that npm renders the package-local README, not the monorepo root README.
  • Add a patch changeset so the README update is published with the next package release.

Validation

  • git diff --cached --check
  • pnpm check:terminology
  • pnpm check:docs
  • pnpm --filter @anarchitecture/ghost build
  • npm_config_cache=/private/tmp/npm-cache npm pack ./packages/ghost --dry-run

Full pre-commit/pre-push hooks were skipped for commit/push from the temp worktree because workspace package links were not installed there; pnpm check failed in that worktree on unrelated local resolution for ghost-fleet imports from @anarchitecture/ghost/*.

@nahiyankhan nahiyankhan marked this pull request as ready for review June 5, 2026 20:27
@nahiyankhan nahiyankhan merged commit fe5d994 into main Jun 5, 2026
4 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.

1 participant