-
Notifications
You must be signed in to change notification settings - Fork 0
Complete documentation migration from fast-url template to afetch library #7
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
Conversation
Co-authored-by: hckhanh <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 40 40
Branches 13 13
=========================================
Hits 40 40 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
CodSpeed Performance ReportMerging #7 will not alter performanceComparing Summary
Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request completes the documentation website migration from fast-url to afetch, transforming all documentation content to reflect the new type-safe API client library with schema validation capabilities.
Key Changes
- Complete documentation rewrite: All three main documentation pages (index, getting-started, api-reference) have been rewritten to document afetch instead of fast-url
- Updated project metadata: Package name changed to "afetch-docs" with appropriate description
- Removed migration note: Deleted the MIGRATION_NOTE.md as the migration is now complete
- Updated license: Copyright transferred to Khánh Hoàng (2025)
Reviewed Changes
Copilot reviewed 8 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/package.json | Updated package name to "afetch-docs" and added description for the documentation website |
| docs/content/docs/meta.json | Removed "introduction" from pages array, keeping only index, getting-started, and api-reference |
| docs/content/docs/index.mdx | Complete rewrite: replaced fast-url URL building content with afetch type-safe API client introduction, features, and examples |
| docs/content/docs/getting-started.mdx | Complete rewrite: replaced fast-url installation/usage with afetch setup, schema validation examples, and type-safe request patterns |
| docs/content/docs/api-reference.mdx | Complete rewrite: replaced fast-url API functions with afetch API documentation including createFetch, type definitions, and comprehensive examples |
| docs/MIGRATION_NOTE.md | Deleted migration tracking note as the documentation update is complete |
| bun.lock | Updated workspace package name reference from "docs" to "afetch-docs" |
| LICENSE | Updated copyright from "Botond Balázs (2020)" to "Khánh Hoàng (2025)" |
| .github/workflows/autofix.yml | Changed dependency installation command from sfw bun ci to sfw bun install |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot check the |
…nces with afetch Co-authored-by: hckhanh <[email protected]>
Fixed in 22ad7c5. Replaced all "fast-url" project references with "afetch" throughout the documentation:
The remaining references to "fast-url library" are correct as they refer to the actual fast-url npm package dependency that afetch uses for URL building. |
Summary
Migrated documentation website from inherited fast-url template to afetch-specific content. Updated LICENSE copyright to reflect current ownership. Fixed API schema examples and replaced all project references from fast-url to afetch.
Details
Documentation Content
createFetch(), type definitions (ApiSchema,ApiPath,FetchOptions,ApiResponse), request patterns, and advanced usage/users/create,/users/:id/update,/posts/create) with clarifying commentsConfiguration & Assets
afetch-docswith proper descriptionurlcat-basic-usage.svg,urlcat-basic-usage-dark.svg)Workflow
bun cicommand for stricter dependency validation in CI environmentsLegal
Cleanup
docs/MIGRATION_NOTE.mdas instructed after completing migration tasksThe documentation now accurately reflects afetch as a type-safe API client with schema validation, with all examples using valid JavaScript object structures and all project references correctly updated from fast-url to afetch.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.