Skip to content
This repository was archived by the owner on Dec 12, 2025. It is now read-only.

Improve documentation clarity and update Deno templates to use correct API#18

Merged
phuctm97 merged 1 commit intomainfrom
new
Jul 6, 2025
Merged

Improve documentation clarity and update Deno templates to use correct API#18
phuctm97 merged 1 commit intomainfrom
new

Conversation

@phuctm97
Copy link
Copy Markdown
Owner

@phuctm97 phuctm97 commented Jul 6, 2025

Summary

  • Improved documentation clarity across README and website
  • Updated Deno templates to use the correct options-based API format
  • Added version plan for patch release

Changes

Documentation Improvements

  • Simplified project description and tagline for better clarity
  • Enhanced feature descriptions (added "guarantee long-term support" to Official SDK feature)
  • Streamlined code examples in README by removing unnecessary callback
  • Added helpful tip about switching between runtime packages
  • Renamed "Setup" to "Initial Steps" for better user guidance

Website Updates

  • Extracted ASCII art logo to a constant for maintainability
  • Updated terminal prompt styling from % to [INFO] for consistency
  • Simplified status section messaging

API Corrections

  • Fixed Deno templates (both JavaScript and TypeScript) to use correct API:
    // Before
    handle(server, (address) => {...})
    
    // After
    handle(server, { onListen: (address) => {...} })

Version Plan

  • Added .nx/version-plans/improve-docs-and-deno-api.md for patch release

Test Plan

  • Documentation renders correctly on website
  • All TypeScript projects pass type checking
  • All projects pass linting
  • Deno templates use the correct API format

🤖 Generated with Claude Code

…t API

This change enhances the project documentation by simplifying the README structure,
clarifying feature descriptions, and updating the website to match. The Deno templates
are updated to use the correct options-based API format for consistency with the SDK design.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jul 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
modelfetch-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 6, 2025 6:26am

@phuctm97 phuctm97 merged commit 9c750c6 into main Jul 6, 2025
2 checks passed
@phuctm97 phuctm97 deleted the new branch July 6, 2025 06:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant