Skip to content

docs: streamline and enhance README (setup, API reference, troubleshooting) #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

naaa760
Copy link

@naaa760 naaa760 commented Jul 13, 2025

Description

#15

  • This PR overhauls the project documentation to make it clearer for new and existing users.
    Key highlights:
  • Streamlined README
  • Added quick-start and installation instructions for uvx, uv, and pip.
  • Clarified API-key setup and Claude Desktop configuration.
  • Re-wrote the tool reference with parameter tables and runnable examples.
  • Added a short “Usage Examples” section covering common workflows.
  • Introduced troubleshooting tips for the most frequent errors.
  • Added badges and improved formatting for better readability.

Consistency & clean-up

  • Fixed code-block fences, table alignment, and markdown linting issues.
  • Ensured no functional code changes; this is a docs-only update.

Motivation:

  • New users reported difficulty understanding setup requirements and practical usage.

These changes provide:

  • Faster onboarding with copy-paste commands.
  • Explicit guidance on the most common tasks (searching, creating issues/tickets, sprint planning).
  • A single, authoritative source of truth (one README).

@naaa760 naaa760 requested a review from a team as a code owner July 13, 2025 21:44
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