Skip to content

docs: improve README and npm discoverability for AI assistants - #5885

Closed
Reccetech wants to merge 1 commit into
hiero-ledger:mainfrom
Reccetech:feat/ai-readme-npm-discoverability
Closed

docs: improve README and npm discoverability for AI assistants#5885
Reccetech wants to merge 1 commit into
hiero-ledger:mainfrom
Reccetech:feat/ai-readme-npm-discoverability

Conversation

@Reccetech

Copy link
Copy Markdown

Summary

  • Updates the README description to name Hiero/Hedera and Kubernetes explicitly
  • Adds a Quick Start section with install + solo one-shot single deploy, linking Simple Solo Setup
  • Moves Documentation above the Releases table
  • Adds homepage to package.json and sharpens its description for the npm package page

Held back: the AI Assistants section pointing at https://solo.hiero.org/llms.txt — that URL is not live yet (pending solo-docs#305). Can be added in a follow-up after Initiative 1 deploys.

Not in this PR: GitHub About description / topics (repo settings; see strategy Initiative 7).

Related: hiero-ledger/solo-docs#304 (priority 2 / strategy Initiative 7)

Test plan

  • README renders correctly on GitHub (badges, code blocks, section order)
  • Quick Start links resolve (solo.hiero.org Simple Solo Setup)
  • package.json is valid JSON
  • After next npm publish, package page shows updated description and homepage

Sharpen the README description to name Hiero/Hedera and Kubernetes, add a
copy-pasteable Quick Start for Simple Solo Setup, and move Documentation
above the Releases table so agents and new users see it first.

Also set package.json homepage to solo.hiero.org and update description for
the npm package page.

The AI Assistants / llms.txt section is held back until solo-docs Initiative 1
ships (hiero-ledger/solo-docs#305).

Related: hiero-ledger/solo-docs#304

Signed-off-by: Keith Kowal <keith.kowal@hashgraph.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
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