-
Notifications
You must be signed in to change notification settings - Fork 16
docs rewrite #686
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
base: main
Are you sure you want to change the base?
docs rewrite #686
Conversation
…translation/gt into gt/docs-rewrite-20250922
…translation/gt into gt/docs-rewrite-20250922
|
The latest updates on your projects. Learn more about Vercel for GitHub.
5 Skipped Deployments
|
|
You have run out of free Bugbot PR reviews for this billing cycle. This will reset on October 16. To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial. |
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.
Greptile Overview
Summary
This comprehensive documentation rewrite adds extensive API documentation, enhanced search functionality, and improved internationalization support. The changes primarily add new documentation content for the core library, implement a sophisticated search system with CJK language support, and enhance the user experience with Open Graph images and analytics.
Major Changes:
- Complete API Documentation: Added comprehensive documentation for all core GT class methods, functions, and types (84 new MDX files)
- Advanced Search System: Implemented localized search with Orama integration, CJK tokenizers for Chinese/Japanese, and keyboard navigation
- Enhanced UX: Added Open Graph image generation, analytics tracking, and improved layout components
- Code Quality: Cleaned up console.log statement in CLI validation code per custom rules
- Internationalization: Restructured documentation organization with better locale-specific routing
The documentation structure follows a logical hierarchy covering core functionality, Next.js integration, React components, and platform-specific guides. All new code follows TypeScript best practices and the existing codebase conventions.
Confidence Score: 5/5
- This PR is safe to merge with minimal risk
- Score reflects the high quality of the documentation rewrite with clean code implementation, proper internationalization patterns, adherence to custom rules (console.log removal), and comprehensive API coverage without introducing any runtime logic changes to core functionality
- No files require special attention - all changes are well-structured documentation and supportive infrastructure
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| apps/docs/app/api/search/[locale]/route.ts | 5/5 | Adds localized search API endpoint with CJK tokenizer support and response caching |
| apps/docs/components/SearchDialog.tsx | 5/5 | Implements custom search dialog with keyboard navigation and CJK tokenizer support |
| apps/docs/app/[locale]/layout.tsx | 5/5 | Updates layout with search functionality, analytics, and i18n configuration |
| packages/cli/src/config/validateSettings.ts | 5/5 | Removes console.log statement from production code |
| packages/next/src/index.server.ts | 5/5 | Clean refactoring of server-side exports and hooks |
| apps/docs/app/api/og/route.tsx | 5/5 | Adds Open Graph image generation API route with light/dark theme support |
Sequence Diagram
sequenceDiagram
participant User
participant SearchDialog
participant SearchAPI
participant OramaTokenizer
participant FumadocsCore
participant MDXContent
User->>SearchDialog: Opens search dialog
SearchDialog->>SearchAPI: GET /api/search/[locale]
SearchAPI->>FumadocsCore: buildIndex(pages)
FumadocsCore->>MDXContent: Load structured data
MDXContent-->>FumadocsCore: Return structured data
FumadocsCore->>FumadocsCore: shrinkStructuredData()
FumadocsCore-->>SearchAPI: Return search indexes
alt Locale is Chinese or Japanese
SearchAPI->>OramaTokenizer: Create CJK tokenizer
OramaTokenizer-->>SearchAPI: Return specialized tokenizer
end
SearchAPI->>SearchAPI: Configure search parameters
SearchAPI-->>SearchDialog: Return search index JSON
SearchDialog->>SearchDialog: Initialize Orama client
User->>SearchDialog: Types search query
SearchDialog->>SearchDialog: Query local Orama instance
SearchDialog->>SearchDialog: Group and format results
SearchDialog-->>User: Display search results
User->>SearchDialog: Selects result
SearchDialog->>User: Navigate to selected page
80 files reviewed, no comments
…translation/gt into gt/docs-rewrite-20250922
…translation/gt into gt/docs-rewrite-20250922
No description provided.