Skip to content

docs: improve GitHub and npm discoverability - #16

Merged
CoderLambert merged 2 commits into
mainfrom
agent/improve-project-discoverability
Jul 13, 2026
Merged

docs: improve GitHub and npm discoverability#16
CoderLambert merged 2 commits into
mainfrom
agent/improve-project-discoverability

Conversation

@CoderLambert

Copy link
Copy Markdown
Owner

Summary

  • sharpen the GitHub and npm positioning around a browser-only React viewer for 20+ formats
  • make English the primary repository README while preserving the full Chinese guide
  • improve npm description, homepage, search keywords, onboarding, and troubleshooting
  • add repository-level LGPL licensing, contribution/security guidance, issue templates, screenshots, and social-preview sources
  • add a patch Changeset so the npm metadata and README ship through the existing release workflow

User impact

Developers can identify FileVista's supported formats and privacy model from search results, reach the live demo immediately, choose the correct base/full/plugin setup, and resolve common integration problems more quickly.

Validation

  • pnpm run lint
  • pnpm typecheck
  • pnpm test — 16 files, 162 tests passed
  • pnpm run build
  • npm pack --dry-run --json
  • git diff --check
  • GitHub About, Homepage, Topics, Social Preview, and private vulnerability reporting verified

@CoderLambert
CoderLambert marked this pull request as ready for review July 13, 2026 08:24
@CoderLambert
CoderLambert merged commit 1d72b2c into main Jul 13, 2026
2 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