-
Notifications
You must be signed in to change notification settings - Fork 30
docs: Add Console Toolkit documentation site #425
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?
Conversation
- Built with Next.js 14, TailwindCSS, and TypeScript - Responsive design matching Storacha's console aesthetic - Collapsible sidebar navigation with nested sections - Fast fuzzy search functionality using Fuse.js - Dark mode optimized with Storacha color palette - Comprehensive documentation pages with examples - Static build compatible with Vercel/Netlify/GitHub Pages - Accessible navigation and content structure - Mobile-first responsive design patterns
- Replace Fuse.js with simple search to avoid hydration issues - Add proper mounting check to prevent SSR/client mismatch - Remove unused Fuse.js dependency - Maintain search functionality with basic string matching - Fix 'Cannot read properties of undefined' error
- Implement basic string matching to replace Fuse.js - Add mounting check to prevent SSR/client mismatch - Remove unused Fuse.js dependency
- Add next-themes for dark/light mode support - Create Providers component to wrap application in ThemeProvider - Implement EditThisPage component for GitHub editing links - Update Layout component to include EditThisPage - Enhance ThemeToggle component for theme switching functionality
hey @virajbhartiya , this needs to be worked further. Issue #406 : Asks for documentation of current UI components which are under active development for
This components are being implemented and after reviewed, shall be feasible for you to skim across the merged PRs and document their setup and utilities in appropriate manner to update the README.md of https://github.com/storacha/upload-service/tree/main/packages/ui lmk if you have any further doubt or query regarding this. ccing: @Dhruv-Varshney-developer for further guidance and pointers on this issue. |
Agree with all pointers of @Nkovaturient. This is important, but supposed to be completed once the components are ready. |
@Nkovaturient can you please take a look at this |
This PR adds a full documentation website for Console Toolkit, aligned with Storacha’s console aesthetic.
What’s included:
docs-site
Next.js 14 app (App Router) with TailwindCSS and TypeScriptnext-themes
with working ThemeToggle/docs
and “Edit this page on GitHub” linksContent added:
quick-start
,installation
,configuration
theming
,colors
,typography
,responsive
overview
,layout
,navigation
,forms
,data-display
core
,utilities
,hooks
,types
Closes #406