Skip to content

Improve npm discoverability: keywords, description, homepage#2

Open
dgarcia360 wants to merge 1 commit into
masterfrom
content/lead/npm-discoverability
Open

Improve npm discoverability: keywords, description, homepage#2
dgarcia360 wants to merge 1 commit into
masterfrom
content/lead/npm-discoverability

Conversation

@dgarcia360

@dgarcia360 dgarcia360 commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

What

Metadata-only change to package.json, version bumped to 1.0.13 for republish:

  • keywords (was: none): docusaurus, docusaurus-plugin, ai, chatbot, ai-search, ask-ai, documentation, docs, rag, search
  • description: now contains "Docusaurus AI chatbot and AI search plugin" (was "Ask AI bot for technical documentation." — no 'Docusaurus', no 'chatbot')
  • homepage → biel.ai/integrations/docusaurus, bugs → repo issues

Why

npm search ranks on name/description/keywords. An audit (2026-06-10) found docusaurus-biel ranks #19 for "docusaurus ai chatbot" and is absent from the top 20 for "docusaurus chatbot" — while no competitor ships a Docusaurus plugin at all.

After merge

Run npm publish — the metadata only takes effect on npm with the new release.

Summary by CodeRabbit

  • Chores
    • Version bumped to 1.0.13
    • Updated package metadata and description

npm search weights name, description, and keywords. The package had no
keywords and a description without the words Docusaurus or chatbot, so
it did not rank for 'docusaurus chatbot' searches. Bumps to 1.0.13 for
republish (metadata-only change).
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4da3ffa9-f6eb-4390-be0f-96b8a627fbf6

📥 Commits

Reviewing files that changed from the base of the PR and between b74f024 and 5b15162.

📒 Files selected for processing (1)
  • package.json

📝 Walkthrough

Walkthrough

Package metadata was updated for release 1.0.13: the version field incremented, description expanded to detail Docusaurus AI chatbot and AI search capabilities, keywords array added with search/AI/chatbot terms, and homepage and bugs URL fields updated.

Changes

Package Release and Metadata Update

Layer / File(s) Summary
Version bump and package metadata
package.json
Version incremented to 1.0.13, description expanded to describe Docusaurus AI chatbot and AI search plugin features, keywords array introduced with Docusaurus, search, AI, chatbot, RAG, and "Ask AI" terms, and marketing fields updated.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

📦 A version bump so small and neat,
Keywords shine with search so sweet,
From 1.0.12 to the new release,
AI chatbot finds its peace,
Metadata sparkles, complete! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating package.json metadata fields (keywords, description, homepage) to improve npm discoverability, which aligns with the primary objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch content/lead/npm-discoverability

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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