Skip to content

docs: improve project discoverability and contributor onboarding - #137

Merged
vitormattos merged 11 commits into
mainfrom
docs/improve-project-discoverability
Sep 28, 2026
Merged

vitormattos merged 11 commits into
mainfrom
docs/improve-project-discoverability

Conversation

@vitormattos

@vitormattos vitormattos commented Sep 28, 2026 •

Copy link
Copy Markdown
Member

Summary

Improve how PDF Elements presents itself to potential users and contributors while keeping the README focused on project discovery.

Changes

  • Rework the README around the project's purpose, value proposition and real use cases.
  • Keep the README as a project overview and navigation page rather than a tutorial.
  • Move installation and first-use guidance to docs/GETTING_STARTED.md.
  • Move the detailed API and theming reference to docs/API.md.
  • Keep contributor workflow and development checks in CONTRIBUTING.md.
  • Add npm and CI badges.
  • Clarify the boundary between the interaction layer and cryptographic PDF signing.
  • Fix contributor setup instructions, including the invalid npm run build:lib reference.
  • Improve package metadata, homepage and npm keywords for discoverability.
  • Add structured bug and feature request forms.
  • Add an issue chooser with links to the demo and LibreSign.
  • Add a pull request template.

The README deliberately does not duplicate license information already represented by the repository license files and GitHub metadata.

@vitormattos
vitormattos requested a review from a team as a code owner September 28, 2026 16:57
@vitormattos
vitormattos merged commit d99298c into main Sep 28, 2026
5 of 6 checks passed
@vitormattos
vitormattos deleted the docs/improve-project-discoverability branch September 28, 2026 17:08
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