Files
spacedrive/docs
Jamie Pine 05acd99e6f Plan action validation, preview, and folder merge
Two opt-in rails on actions, both taking the action's exact input:
validate answers whether and how an operation runs and is re-run at
dispatch, preview answers what will exist afterward as an FsPlan from
the index, browsable through plan handles as an overlay on directory
listings. Folder merge is the first tenant. The plan catalogs both
rails across copy, move, merge, delete, batch rename, and dedupe, and
registers the teardown of the unreachable ValidationResult rail and
the CLI's local conflict logic.
2026-09-22 04:21:44 -07:00
..

Spacedrive Documentation

The Spacedrive docs site, built with Fumadocs on Next.js. This directory is a standalone app with its own bun install, separate from the repo workspace.

bun install
bun run dev      # dev server on localhost:3000
bun run build    # production build

Or from the repo root: just dev-docs / just build-docs. Requires Node 20+.

Layout

  • overview/, core/, extensions/, cli/, react/, gpui/: published MDX content, one sidebar tab per folder. Navigation order lives in each folder's meta.json.
  • app/, lib/, components/: the Next.js app. Pages are served from the site root, so core/jobs.mdx renders at /core/jobs.
  • public/: images, logo, favicon.
  • plans/, core/design/, design/, archive/: internal working docs, not part of the site.
  • WRITING_GUIDE.mdx, CODE_COMMENTS.mdx: contributor guides, not published.

Writing pages

Frontmatter supports title, description, and sidebarTitle (a shorter name for the sidebar). Callouts, <Steps>, <Tabs>, <Cards>, and <Accordions> are registered globally, so no imports are needed in MDX. Every page is also served as raw markdown at <path>.md and indexed in /llms.txt.