Create comprehensive documentation for fast-url using fumadocs

.changeset/slimy-frogs-roll.md

@@ -0,0 +1,5 @@
+---
+"fast-url": patch
+---
+
+Add documentation and update homepage

codecov.yml

@@ -0,0 +1,14 @@
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+    patch:
+      default:
+        target: auto
+        threshold: 1%
+
+ignore:
+  - "web/"
+  - "web/**/*"

package.json

@@ -7,7 +7,7 @@
     "email": "[email protected]",
     "url": "https://www.khanh.id"
   },
-  "homepage": "https://github.com/hckhanh/fast-url",
+  "homepage": "https://fast-url.khanh.id",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/hckhanh/fast-url.git"

web/.gitignore

@@ -0,0 +1,26 @@
+# deps
+/node_modules
+
+# generated content
+.source
+
+# test & build
+/coverage
+/.next/
+/out/
+/build
+*.tsbuildinfo
+
+# misc
+.DS_Store
+*.pem
+/.pnp
+.pnp.js
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# others
+.env*.local
+.vercel
+next-env.d.ts

web/INSTRUCTION.md

@@ -0,0 +1,29 @@
+Do the task for me
+
+
+As a opensource documentation writer, update this folder `web`
+
+This is the sample project from fumadocs, It will be used to deploy the documentation website for this project.
+
+The current content of the doc is just sample content, you need to replace it with relevant documentation content for this project.
+
+Here is the structure of the documentation you need to create:
+
+* Introduction
+  * Why this folk is created
+  * Key features (read the project to get the features)
+  * The disadvantages of using the original project (non-optimized, not regularly updated,...) - https://github.com/balazsbotond/urlcat
+  * How this fork addresses those issues
+* Getting Started
+  * Installation
+  * Usage
+* API Reference
+
+Each section should be in a separate mdx file and should utilize different components from fumadocs to enhance the documentation.
+
+Ensure that the content is clear, concise, and provides value to the users of the project. Use examples, code snippets, and other relevant information to make the documentation comprehensive and user-friendly.
+
+After updating the documentation, ensure to review and proofread the content for accuracy and clarity before finalizing it.
+Then update SEO metadata for each doc page to improve search engine visibility.
+
+Finally, test the documentation website locally to ensure all links, components, and features are functioning correctly before deploying the updated documentation.

web/README.md

@@ -0,0 +1,45 @@
+# web
+
+This is a Next.js application generated with
+[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
+
+Run development server:
+
+```bash
+npm run dev
+# or
+pnpm dev
+# or
+yarn dev
+```
+
+Open http://localhost:3000 with your browser to see the result.
+
+## Explore
+
+In the project, you can see:
+
+- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
+- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.
+
+| Route                     | Description                                            |
+| ------------------------- | ------------------------------------------------------ |
+| `app/(home)`              | The route group for your landing page and other pages. |
+| `app/docs`                | The documentation layout and pages.                    |
+| `app/api/search/route.ts` | The Route Handler for search.                          |
+
+### Fumadocs MDX
+
+A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
+
+Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
+
+## Learn More
+
+To learn more about Next.js and Fumadocs, take a look at the following
+resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
+  features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- [Fumadocs](https://fumadocs.dev) - learn about Fumadocs

web/biome.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "../node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": "//",
+  "root": false,
+  "files": {
+    "ignoreUnknown": true,
+    "includes": ["**", "!node_modules", "!.next", "!dist", "!build", "!.source"]
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    },
+    "domains": {
+      "next": "recommended",
+      "react": "recommended"
+    }
+  }
+}