Skip to content

Commit 82a6dd1

Browse files
committed
docs: update documentation files
1 parent f25045a commit 82a6dd1

2 files changed

Lines changed: 84 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88

9-
## [0.0.9] - 2026-01-27
9+
## [0.1.0] - 2026-01-27
1010

1111
**Website & Documentation Overhaul** - Enhanced developer experience with comprehensive docs site.
1212

@@ -79,6 +79,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7979
This is a **minor** release with no breaking API changes:
8080

8181
```bash
82+
npm install react-meta-seo@latest
83+
# or
8284
npm update react-meta-seo
8385
```
8486

website/CHANGELOG.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,87 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88

9+
## [0.1.0] - 2026-01-27
10+
11+
**Website & Documentation Overhaul** - Enhanced developer experience with comprehensive docs site.
12+
13+
### 🌐 Website Improvements
14+
15+
**New Documentation Pages**
16+
- **Changelog Page** (`/changelog`): Dedicated page for version history
17+
- **Comparison Page** (`/comparison`): Detailed comparison with react-helmet and Next.js Metadata
18+
- **Migration Guide** (`/migration`): Step-by-step migration from react-helmet-async
19+
- **Code of Conduct** (`/code-of-conduct`): Community guidelines
20+
- **Contributing Guide** (`/contributing`): Contribution workflow and testing instructions
21+
22+
**SEO Enhancements**
23+
- Added `robots.ts` for search engine indexing control
24+
- Added `sitemap.ts` for automatic sitemap generation
25+
- Improved meta tags across all pages
26+
27+
**UI/UX Improvements**
28+
- Enhanced navigation with dedicated pages for each doc section
29+
- Updated styling in `globals.css`
30+
- Improved layout with better mobile responsiveness (`layout.tsx`)
31+
- Enhanced homepage with better feature showcase (`page.tsx`)
32+
33+
### 🛠️ CLI Improvements
34+
35+
**Streaming Sitemap Generator** (Refactored)
36+
- Fully refactored CLI to use streaming JSON parsing
37+
- Added `stream-chain` and `stream-json` as production dependencies
38+
- Memory-efficient processing of large route files (10k+ routes)
39+
- Improved error handling with async/await pattern
40+
41+
**Better Code Organization**
42+
- Extracted `processRoute()` helper function
43+
- Extracted `finishStream()` helper function
44+
- More maintainable codebase with clear separation of concerns
45+
46+
### 📚 Documentation
47+
48+
**Enhanced Documentation Structure**
49+
- Split documentation into dedicated pages (COMPARISON.md, MIGRATION.md)
50+
- Improved table of contents in DOCUMENTATION.md
51+
- Better organization of content for easier navigation
52+
53+
**Content Updates**
54+
- Updated README.md with Production-Ready status
55+
- Synchronized website/DOCUMENTATION.md with latest changes
56+
- Added comprehensive comparison charts
57+
58+
### 🔧 Development Experience
59+
60+
**Build & Tooling**
61+
- Added TypeScript types for streaming dependencies (`@types/stream-chain`, `@types/stream-json`)
62+
- Updated devDependencies (`@vitest/coverage-v8` 1.2.1 → 1.6.1)
63+
64+
**Website Infrastructure**
65+
- Enhanced `copy-docs.js` script for better doc synchronization
66+
- Added utility functions in `src/lib/utils.ts`
67+
- Improved docs parsing in `src/lib/docs.ts`
68+
69+
### Fixed
70+
71+
- **CLI**: Removed synchronous JSON file loading (OOM risk with large files)
72+
- **CLI**: Fixed route streaming to properly handle large datasets
73+
- **Website**: Fixed navigation links between documentation sections
74+
- **Website**: Improved mobile responsiveness across all pages
75+
76+
### Migration from 0.0.8
77+
78+
This is a **minor** release with no breaking API changes:
79+
80+
```bash
81+
npm install react-meta-seo@latest
82+
```
83+
84+
**What's New:**
85+
- Visit the new documentation pages at `https://react-meta-seo.vercel.app/changelog`
86+
- Check out the comparison guide at `/comparison`
87+
- Learn migration steps at `/migration`
88+
89+
990
## [0.0.8] - 2026-01-26
1091

1192
**Production-Ready Release** - Audit-verified for enterprise adoption.

0 commit comments

Comments
 (0)