Skip to content

Improve project discoverability and SEO#90

Merged
MoonWorm merged 1 commit intoMoonWorm:mainfrom
a-sinkevich:improve-seo-and-discoverability
Mar 23, 2026
Merged

Improve project discoverability and SEO#90
MoonWorm merged 1 commit intoMoonWorm:mainfrom
a-sinkevich:improve-seo-and-discoverability

Conversation

@a-sinkevich
Copy link
Contributor

@a-sinkevich a-sinkevich commented Mar 21, 2026

The README's generic heading and one-line description make the project hard to discover across GitHub, Google, and Maven Central.

Add a focused and keyword-rich title, feature overview, JSON:API explainer, documentation links, and a framework comparison. Update Maven Central and GitHub Pages metadata to match.

Documentation only.

- Replace generic "Introduction" heading with keyword-rich title
  "JsonApi4j — JSON:API Specification Framework for Java"
- Add Features section with scannable bullet points
- Add "Why JSON:API?" section to capture search intent
- Add Documentation links section
- Add Alternatives comparison table (crnk, Elide)
- Add keyword-rich footer for search engine indexing
- Update parent pom.xml description from "Parent POM module" to
  meaningful project description visible on Maven Central
- Add title and expand description in docs/_config.yml for
  GitHub Pages SEO metadata
@MoonWorm MoonWorm self-requested a review March 23, 2026 17:51
@MoonWorm MoonWorm merged commit dfd1c7e into MoonWorm:main Mar 23, 2026
1 check 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.

2 participants