Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add Fumadocs documentation website to HyperView #14

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.

Sign up for GitHub

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

Jump to bottom
Draft
Copilot wants to merge 5 commits into
base: hyperview-base
Choose a base branch
from
Draft

Add Fumadocs documentation website to HyperView #14

Copilot wants to merge 5 commits into from
+8,259 −2,978

Conversation

Copy link

Copilot AI commented Dec 29, 2025 •
edited
Loading

Implements a documentation website using Fumadocs MDX, integrated into the existing Next.js frontend at /docs. Migrates existing documentation from docs/ folder into structured MDX format.

Changes

Documentation Structure

  • 5 MDX pages: Welcome, Getting Started, Architecture, Datasets, API Reference
  • Migrated content from docs/architecture.md and docs/datasets.md
  • Consolidated README content into Getting Started guide

Fumadocs Integration

  • Configured fumadocs-mdx with source.config.ts for MDX processing
  • Custom source loader in src/app/source.ts to extract file paths from fumadocs collections
  • Next.js App Router catch-all route: app/docs/[[...slug]]/page.tsx
  • Static site generation via generateStaticParams()

Styling

  • Tailwind typography plugin for markdown prose styling
  • Custom dark theme matching project's slate/indigo palette
  • Sidebar navigation with header and GitHub link
  • Code block syntax highlighting and proper inline code styling

Type Safety

interface DocEntry {
  title: string;
  description?: string;
  body: React.ComponentType;
  info?: {
    path: string;
    fullPath: string;
  };
}

Screenshots

Documentation Homepage
docs-homepage

Getting Started Page
docs-getting-started

Notes

  • Added .source/ to gitignore (fumadocs generated files)
  • Cross-platform commands included (Windows/macOS/Linux)
  • Compatible with Next.js static export (output: "export")

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • img.shields.io
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/HyperView/HyperView/frontend/.next/build/webpack-loaders.js 37621 (dns block)
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/HyperView/HyperView/frontend/.next/build/webpack-loaders.js 37229 (dns block)
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/HyperView/HyperView/frontend/.next/build/webpack-loaders.js 34195 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Overview

Add a documentation website to the HyperView project using Fumadocs, integrated into the existing Next.js frontend.

Requirements

1. Fumadocs Setup

  • Install fumadocs-core, fumadocs-ui, and fumadocs-mdx packages in the frontend/ directory
  • Configure Fumadocs with source.config.ts
  • Set up the docs route at /docs using Next.js App Router (app/docs/[[...slug]]/page.tsx)
  • Configure MDX support for documentation pages

2. MVP Landing Page

Create an attractive landing page for the documentation site that includes:

  • Hero section with HyperView branding and tagline: "Open-source dataset curation with hyperbolic embeddings visualization"
  • Key features highlights (from README):
    • Dual-Panel UI: Image grid + scatter plot with bidirectional selection
    • Euclidean/Hyperbolic Toggle: Switch between standard 2D UMAP and Poincaré disk visualization
    • HuggingFace Integration: Load datasets directly from HuggingFace Hub
    • Fast Embeddings: Uses EmbedAnything for CLIP-based image embeddings
    • FiftyOne-like API: Familiar workflow for dataset exploration
  • Quick start section with installation commands
  • Links to documentation sections

3. Initial Documentation Structure

Create MDX content files migrating/incorporating existing docs:

  • content/docs/index.mdx - Documentation home
  • content/docs/getting-started.mdx - Quick start guide (from README)
  • content/docs/architecture.mdx - Migrate from existing docs/architecture.md
  • content/docs/datasets.mdx - Migrate from existing docs/datasets.md
  • content/docs/api-reference.mdx - API endpoints documentation

4. Styling

  • Use Tailwind CSS (already in the project)
  • Match the existing project aesthetic
  • Dark mode support (the project uses slate color scheme)

5. Navigation

  • Set up proper navigation structure in Fumadocs
  • Include sidebar navigation for docs pages
  • Add header with links to GitHub repo

Technical Context

  • Frontend is Next.js 16 with React 18
  • Uses Tailwind CSS for styling
  • Package manager is npm (in frontend/) and uv (for Python)
  • Existing docs are in docs/ folder: architecture.md, datasets.md, index.html

Reference

This pull request was created from Copilot chat.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Dec 29, 2025
Copilot AI changed the title [WIP] Add documentation website to HyperView project Add Fumadocs documentation website to HyperView Dec 29, 2025
Copilot AI requested a review from mnm-matin December 29, 2025 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mnm-matin mnm-matin Awaiting requested review from mnm-matin

Assignees

@mnm-matin mnm-matin

Copilot code review Copilot

Labels

None yet

Projects

HyperView Main Dev
Status: Backlog

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mnm-matin