User-facing documentation for docs.fil.one. Built with Docusaurus and deployed to Vercel.
npm install
npm startOpens at http://localhost:3000/.
To preview a production build locally:
npm run build
npm run servenpm run buildStatic output goes to ./build/.
- Push this repo to GitHub (
FilecoinFoundationWeb/filone-docs). - Go to vercel.com/new and import the repo.
- Vercel auto-detects Docusaurus. Confirm these settings:
- Build Command:
npm run build - Output Directory:
build - Install Command:
npm install
- Build Command:
- Click Deploy.
- In the Vercel project dashboard, go to Settings > Domains.
- Add
docs.fil.oneand set a CNAME record pointing tocname.vercel-dns.com.
Every push to main triggers a production deploy. Pull requests get preview deployments automatically.
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
- Create a branch.
- Edit or add
.mdxfiles indocs/. - Mirror any factual change into the LLM files.
static/llms.txtandstatic/llms-full.txtare hand-maintained copies of the site with no generation script — a fix applied only todocs/*.mdxleaves the wrong value live atdocs.fil.one/llms-full.txt, which is what LLM crawlers read. Update both, every time. - Check
docusaurus.config.js. Its JSON-LD structured-data block carries product claims (description, featureList, price) that a page-level fix won't reach. - Grep the whole tree for paraphrases, not just the value. The same claim is often restated in different words across the quickstart, SDK, and app pages — "geographic data residency options" is a stale region claim that no value-based search would find.
- Run
npm startto preview locally. - Open a PR. Vercel will create a preview deployment.