docs: Add Console Toolkit documentation site#425
docs: Add Console Toolkit documentation site#425virajbhartiya wants to merge 9 commits intostoracha:mainfrom
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 storacha/console-toolkit#5 : 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 |
|
still doesnt address the issue. |
3 participants
This PR adds a full documentation website for Console Toolkit, aligned with Storacha’s console aesthetic.
What’s included:
docs-siteNext.js 14 app (App Router) with TailwindCSS and TypeScriptnext-themeswith working ThemeToggle/docsand “Edit this page on GitHub” linksContent added:
quick-start,installation,configurationtheming,colors,typography,responsiveoverview,layout,navigation,forms,data-displaycore,utilities,hooks,typesCloses storacha/console-toolkit#5