Fil One Docs

User-facing documentation for docs.fil.one. Built with Docusaurus and deployed to Vercel.

Before editing content, read AGENTS.md — guidelines for anyone (human or AI agent) changing this repo, including the rule that static/llms.txt and static/llms-full.txt must be updated alongside any factual change to docs/**.

Local development

npm install
npm start

Opens at http://localhost:3000/.

To preview a production build locally:

npm run build
npm run serve

Build

npm run build

Static output goes to ./build/.

Deploy to Vercel

First-time setup

1. Push this repo to GitHub (FilecoinFoundationWeb/filone-docs).
2. Go to vercel.com/new and import the repo.
3. Vercel auto-detects Docusaurus. Confirm these settings:
   • Build Command: npm run build
   • Output Directory: build
   • Install Command: npm install
4. Click Deploy.

Custom domain (docs.fil.one)

1. In the Vercel project dashboard, go to Settings > Domains.
2. Add docs.fil.one and set a CNAME record pointing to cname.vercel-dns.com.

Automatic deploys

Every push to main triggers a production deploy. Pull requests get preview deployments automatically.

Project structure

AGENTS.md                # Guidelines for anyone (human or AI agent) editing this repo
docs/                    # All documentation pages (MDX)
  quickstart/            # Getting started guides
  storage/               # Buckets, objects, versioning, object lock, multipart
  security/              # Auth, API keys, encryption
  billing/               # Trial, pricing, usage
  app/                   # Dashboard guides
  reference/             # API reference, S3 compat, errors
  sdk/                   # SDK examples per language
  bucket-intelligence.mdx
  faq.mdx
  limits.mdx
  introduction.mdx
docusaurus.config.js     # Site config (navbar, theme, JSON-LD structured data)
sidebars.js              # Sidebar navigation structure
src/                     # Custom React components and CSS
  css/custom.css         # Custom styles
static/                  # Served as-is at the site root
  img/                   # Logo, favicon, images
  llms.txt               # Hand-maintained LLM index mirror
  llms-full.txt          # Hand-maintained full-site LLM mirror
  robots.txt             # Crawler directives + sitemap pointer
vercel.json              # Vercel deployment config

Contributing

1. Create a branch.
2. Edit or add .mdx files in docs/.
3. Follow AGENTS.md — it covers keeping static/llms.txt / static/llms-full.txt in sync, checking docusaurus.config.js for claims outside docs/**, and verifying facts before publishing them.
4. Run npm start to preview locally.
5. Open a PR. Vercel will create a preview deployment.