feat: prefer package.json description over README-inferred#1107
Merged
Conversation
commit: |
taras
force-pushed
the
feat/package-json-description
branch
from
ca6ba97 to
afef6cf
Compare
cowboyd
reviewed
Feb 17, 2026
Member
cowboyd
left a comment
cowboyd
left a comment
There was a problem hiding this comment.
Shouldn't the llms-txt-route be in the sitemap?
Update Node package adapter to read description from package.json manifest and fall back to README extraction when not present. This ensures the /llms.txt route and package listings show concise, agent-friendly descriptions written specifically for npm search and AI discovery. Changes: - Add description to PackageJsonSchema - Add description to PackageManifest interface - Update getManifest() to include description - Update getDescription() to prefer manifest over README
taras
force-pushed
the
feat/package-json-description
branch
from
afef6cf to
17ebdeb
Compare
Member
Author
|
Rebased onto v4 to resolve conflicts. Regarding the sitemap question: yes! PR #1106 (which merged separately) added This PR now just focuses on the core change: making |
cowboyd
approved these changes
Mar 3, 2026
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.
Motivation
With thefrontside/effectionx#151 merged, all
@effectionx/*packages now have concisedescriptionfields in theirpackage.jsonfiles. These descriptions are written specifically for npm search and AI agent discovery.The current website reads descriptions from README files, parsing them through a rehype pipeline that extracts the first paragraph. This produces verbose, 200-character excerpts that aren't ideal for the
/llms.txtroute or package listings.Approach
Update the package abstraction to prefer
package.jsondescription over README-inferred description:Add
descriptionto schemas:PackageJsonSchemainwww/lib/package/node.tsPackageManifestinterface inwww/lib/package/types.tsUpdate
getManifest()to include description in returned manifestUpdate
getDescription()in bothnode.tsanddeno.tsto:This ensures the
/llms.txtroute generates concise, agent-friendly descriptions like:Instead of verbose paragraph excerpts.