Skip to content

Conversation

virajbhartiya
Copy link

This PR adds a full documentation website for Console Toolkit, aligned with Storacha’s console aesthetic.

What’s included:

  • New docs-site Next.js 14 app (App Router) with TailwindCSS and TypeScript
  • Responsive layout with collapsible Sidebar, Header, and Footer
  • Dark/light mode via next-themes with working ThemeToggle
  • Docs index at /docs and “Edit this page on GitHub” links
  • Fast client-side search (lightweight string match, SSR-safe)
  • Static export-ready build (Vercel/Netlify/GitHub Pages compatible)

Content added:

  • Getting Started: quick-start, installation, configuration
  • Styling: theming, colors, typography, responsive
  • Components: overview, layout, navigation, forms, data-display
  • API: core, utilities, hooks, types

Closes #406

- 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
@Nkovaturient
Copy link

Nkovaturient commented Sep 17, 2025

hey @virajbhartiya , this needs to be worked further.

Issue #406 : Asks for documentation of current UI components which are under active development for

packages/ui/ : is the main working area where we need to implement the console ui-features as a standalone components. hence, this documentation should encompass the setting up, workflow, features, utilization, and other as mentioned here #406 -- comprehensively for each below-mentioned components:

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 examples/ and packages/ui .

https://github.com/storacha/upload-service/tree/main/packages/ui
https://github.com/storacha/upload-service/blob/main/packages/ui/README.md
https://github.com/storacha/upload-service/blob/main/packages/ui/examples/README.md

lmk if you have any further doubt or query regarding this.

ccing: @Dhruv-Varshney-developer for further guidance and pointers on this issue.

@Dhruv-Varshney-developer
Copy link
Contributor

Agree with all pointers of @Nkovaturient. This is important, but supposed to be completed once the components are ready.

@virajbhartiya
Copy link
Author

@Nkovaturient can you please take a look at this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation & Examples Site for storacha console toolkit

3 participants