Skip to content

docs: rewrite with clean, concise style#43

Merged
rohitg00 merged 2 commits intomainfrom
docs/clean-simple-style
Feb 4, 2026
Merged

docs: rewrite with clean, concise style#43
rohitg00 merged 2 commits intomainfrom
docs/clean-simple-style

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented Feb 4, 2026

Summary

  • Rewrote all core docs pages with problem/solution framing and conversational tone (inspired by skyll.app's documentation style)
  • Reduced total docs content from 722 lines to 366 lines while keeping all information
  • Updated OpenAPI descriptions and api.html meta to match new style

Pages rewritten

  • index.mdx — Clean problem statement, progressive quick start, focused feature sections
  • rest-api.mdx — Progressive curl examples, clear ranking explanation, endpoint reference
  • mcp-server.mdx — Natural language tool descriptions, conversational setup instructions
  • python-client.mdx — Quick-start-first approach, progressive examples
  • installation.mdx — Simpler, less repetition, focused
  • quickstart.mdx — Four-step guide, no redundancy with installation page

Test plan

  • npx next build passes for fumadocs (26 pages generated)
  • npx vite build passes for skillkit website
  • All existing docs pages render correctly
  • OpenAPI spec descriptions updated to match new tone

Open with Devin

Summary by CodeRabbit

  • Documentation
    • Rewrote site content with concise, benefit-focused messaging and streamlined navigation
    • Consolidated Quick Start and installation into shorter, command-driven flows (no global install by default)
    • Reworked MCP server and Python client guides to emphasize native/runtime usage and practical examples
    • Updated REST/OpenAPI docs and API page copy with clearer, user-facing endpoint descriptions and examples

Rewrote all core docs pages (index, installation, quickstart, rest-api,
mcp-server, python-client) with problem/solution framing, progressive
code examples, and conversational tone. Updated OpenAPI descriptions
and api.html meta tags to match. 366 additions vs 722 deletions.
@vercel
Copy link
Copy Markdown

vercel bot commented Feb 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
skillkit Ready Ready Preview, Comment Feb 4, 2026 10:54am
skillkit-docs Ready Ready Preview, Comment Feb 4, 2026 10:54am

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

Comprehensive rewrite of user-facing documentation: streamlines copy, reorganizes quick-start and installation flows, converts technical API/reference pages into concise, example-driven guides, and updates API metadata/OpenAPI descriptions for clearer, action-oriented wording.

Changes

Cohort / File(s) Summary
Landing & guides
docs/fumadocs/content/docs/index.mdx, docs/fumadocs/content/docs/quickstart.mdx, docs/fumadocs/content/docs/installation.mdx
Rewrote intro and quickstart content to a concise value proposition and command-driven flow; removed lengthy feature tables and interactive onboarding details; simplified install/init guidance and project initialization examples.
API & client docs
docs/fumadocs/content/docs/mcp-server.mdx, docs/fumadocs/content/docs/rest-api.mdx, docs/fumadocs/content/docs/python-client.mdx
Shifted from parameter-rich reference to narrative, prompt- and example-focused usage; removed detailed parameter tables and extensive API/model listings; reframed MCP and REST guidance around runtime behavior and simple examples.
OpenAPI / static API site
docs/skillkit/public/openapi.json, docs/skillkit/public/api.html
Updated OpenAPI info and endpoint descriptions to be more user-facing and action-oriented; adjusted HTML meta title/description for the static API docs page.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

🐰 I hopped through docs with pen so light,

trimmed the weeds and made paths bright.
Commands like carrots, short and sweet,
agents find skills — a tasty treat.
Hop on, try it — quick, delightful bite!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: rewrite with clean, concise style' directly and clearly summarizes the main change—a documentation rewrite focused on improving style and clarity.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/clean-simple-style

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.

Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 5 additional flags.

Open in Devin Review

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@docs/fumadocs/content/docs/mcp-server.mdx`:
- Around line 8-10: Replace the hard-coded "15,000+" skill count strings in the
MCP docs with a non-specific phrase (e.g., "thousands of skills") or remove the
numeric claim; locate the two occurrences of the literal "15,000+" in the MCP
documentation text (the sentences mentioning the `@skillkit/mcp` package and the
agent "direct line") and update them to a softer, non-stale wording (or
implement a dynamic insertion that pulls the current catalog size if you prefer
a precise number).
- Around line 54-67: The "Browse categories" tool description is missing the
tool name; update the "Browse categories" section (near other tools like
search_skills, get_skill, recommend_skills) to explicitly state that the agent
calls list_categories and returns all categories with counts—e.g., add a
sentence like "The agent calls list_categories and returns all categories with
counts" under the "Browse categories" heading so users can reference the
list_categories tool by name.

Replace hard-coded "15,000+" with non-specific wording and explicitly
name the list_categories tool in the Browse categories section.
@rohitg00 rohitg00 merged commit 1ee5258 into main Feb 4, 2026
10 checks passed
@rohitg00 rohitg00 deleted the docs/clean-simple-style branch February 4, 2026 11:01
Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 new potential issue.

View issue and 8 additional flags in Devin Review.

Open in Devin Review

class Category:
name: str
count: int
Skill(name, source, description, tags, category, content, score)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Python client documentation lists non-existent score field and omits actual fields

The Python client documentation incorrectly describes the Skill model fields.

Click to expand

Documentation vs Actual Model

The documentation at line 88 states:

Skill(name, source, description, tags, category, content, score)

But the actual Skill model in clients/python/skillkit/models.py:5-14 is:

class Skill(BaseModel):
    name: str
    description: Optional[str] = None
    source: str
    repo: Optional[str] = None
    tags: Optional[list[str]] = None
    category: Optional[str] = None
    content: Optional[str] = None
    stars: Optional[int] = None
    installs: Optional[int] = None

Issues

  1. score doesn't exist - The documentation lists score as a field, but the actual model has no such field. Developers trying to access skill.score will get an AttributeError.
  2. Missing fields - The documentation omits repo, stars, and installs which are actual fields on the model.

Impact

Developers following this documentation will write code expecting a score attribute that doesn't exist, leading to runtime errors.

Recommendation: Update line 88 to accurately reflect the model: Skill(name, source, description, tags, category, content, repo, stars, installs)

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

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