Update READMEs for npm - #291
Merged
Merged
Conversation
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.
Note
Low Risk
Documentation, npm metadata, and packaging comments only; no application or library runtime logic changes.
Overview
Improves how TrueForge packages look on npm and in docs by adding package READMEs, shipping them in tarballs, and aligning branding with trueforge.dev.
New READMEs for
@truefoundry/trueforge-coreand@truefoundry/trueforge(quick start, links to docs, related packages).@truefoundry/trueforge-sdkREADME gains a Documentation section pointing to the API reference.npm tarballs for
trueforge-coreandtrueforgenow includeREADME.mdviafiles;RELEASING.md,AGENTS.md, andcheck-dist.mjscomments are updated to match.Metadata:
homepagefor core and trueforge packages moves from GitHub tree URLs tohttps://trueforge.dev; descriptions use “Agent Harness” wording. Root README adds a row of npm version badges for the four published packages.Fern
generators.ymlsetsapiName: TrueForge,apiReferenceLink, and the same Agent Harness intro text. A changeset records a patch bump for@truefoundry/trueforge-sdkfrom OpenAPI regeneration (no SDK source diff in this PR beyond README).Reviewed by Cursor Bugbot for commit 29551c5. Bugbot is set up for automated code reviews on this repo. Configure here.