Skip to content

Conversation

@hckhanh
Copy link
Owner

@hckhanh hckhanh commented Nov 3, 2025

### Summary
This pull request revises the README file for improved clarity and adds expanded API documentation for better user guidance. New sections on installation, usage examples, and Vietnamese language rules have been included. Dependencies have been updated, incorporating `vn-number` for enhanced integration.

Additionally, a new `docs` directory has been initialized, featuring a `.gitignore`, base README, and support files for documentation. Biome has been configured for linting and formatting, with a `bun.lock` file to manage dependencies.

### Changes
- Improved README with expanded content and clearer language.
- Added detailed API documentation, including installation and usage.
- Introduced `vn-number` dependency for better functionality.
- Established `docs` directory and support files for project documentation.
- Configured Biome for linting and included a `bun.lock` file.

### Checklist
- [ ] I have added necessary documentation for my changes.
- [ ] I have updated the README as needed.
- [ ] I have tested my changes and fixed any issues discovered.

Added `.gitignore`, `README.md`, and initial support files under the `docs` directory. Configured Biome for linting and formatting, and included a `bun.lock` file to manage dependencies. This sets up the foundation for project documentation.
Revised the README file to improve clarity, consistency, and grammar. Added new sections in the API documentation covering installation, usage examples, and Vietnamese language rules. Updated dependencies and included `vn-number` for better integration.
Copilot AI review requested due to automatic review settings November 3, 2025 15:53
@hckhanh hckhanh self-assigned this Nov 3, 2025
@codecov-commenter
Copy link

codecov-commenter commented Nov 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (014b6b1) to head (937b31c).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #46   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          245       245           
  Branches        82        82           
=========================================
  Hits           245       245           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

Copilot AI left a 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 PR adds comprehensive documentation for the vn-number library using Next.js and Fumadocs. The main purpose is to create a documentation website that provides detailed API references, usage examples, and guides for the library.

Key changes:

  • Sets up a Next.js-based documentation site with Fumadocs UI framework
  • Adds comprehensive MDX documentation covering API reference and getting started guides
  • Updates the main README with better structure and more detailed examples

Reviewed Changes

Copilot reviewed 25 out of 29 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
mise.toml Adds Bun 1.3.1 to the development tools configuration
docs/vercel.json Configures Vercel deployment to use Bun 1.x
docs/package.json Defines Next.js documentation site dependencies
docs/bun.lock Bun lockfile for docs dependencies
docs/biome.json Linter and formatter configuration for the docs project
docs/tsconfig.json TypeScript configuration for the documentation site
docs/next.config.mjs Next.js configuration with MDX support
docs/source.config.ts Fumadocs MDX configuration for content processing
docs/postcss.config.mjs PostCSS configuration for Tailwind CSS
docs/src/mdx-components.tsx MDX component customization setup
docs/src/lib/source.ts Content source adapter configuration
docs/src/lib/layout.shared.tsx Shared layout options for documentation pages
docs/src/fonts.ts Font configuration (JetBrains Mono)
docs/src/app/og/docs/[...slug]/route.tsx Open Graph image generation for docs pages
docs/src/app/llms-full.txt/route.ts LLM-friendly text export endpoint
docs/src/app/layout.tsx Root layout with metadata and font setup
docs/src/app/global.css Global CSS with Tailwind and Fumadocs styles
docs/src/app/docs/layout.tsx Documentation section layout
docs/src/app/docs/[[...slug]]/page.tsx Dynamic documentation page rendering
docs/src/app/api/search/route.ts Search API endpoint
docs/content/docs/meta.json Documentation navigation metadata
docs/content/docs/index.mdx Getting started documentation
docs/content/docs/api-reference.mdx Complete API reference documentation
docs/README.md Documentation project README
docs/.gitignore Gitignore for documentation project
README.md Updated main README with improved structure and examples
pnpm-lock.yaml Updated lockfile with removed Biome platform-specific packages and added libc metadata
Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,3 @@
{
"bunVersion": "1.x"
Copy link

Copilot AI Nov 3, 2025

Choose a reason for hiding this comment

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

[nitpick] Using a major version range '1.x' for bunVersion may lead to unexpected behavior when Bun releases breaking changes in minor versions. Consider pinning to a specific version or using a more restrictive range like '1.3.x' for better reproducibility.

Suggested change
"bunVersion": "1.x"
"bunVersion": "1.3.x"

Copilot uses AI. Check for mistakes.
"@types/node": "24.9.2",
"@types/react": "19.2.2",
"@types/react-dom": "19.2.2",
"postcss": "8.5.6",
Copy link

Copilot AI Nov 3, 2025

Choose a reason for hiding this comment

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

PostCSS 8.5.6 is outdated and may contain known security vulnerabilities. The latest PostCSS 8.x versions address several security issues. Consider updating to the latest 8.x version (8.4.x series).

Suggested change
"postcss": "8.5.6",
"postcss": "8.4.38",

Copilot uses AI. Check for mistakes.
@codspeed-hq
Copy link

codspeed-hq bot commented Nov 3, 2025

CodSpeed Performance Report

Merging #46 will not alter performance

Comparing docs (937b31c) with main (014b6b1)

Summary

✅ 64 untouched

Introduced `ReadVnNumber` component for interactive Vietnamese number reading example. Replaced tab-based code samples with dynamic input field for better user engagement. Adjusted Biome configuration and updated class ordering in layout for consistency.
@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 3, 2025

@hckhanh hckhanh merged commit 253e521 into main Nov 3, 2025
5 of 8 checks passed
@hckhanh hckhanh deleted the docs branch November 3, 2025 16:46
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.

3 participants