Skip to content

docs: sidebar, terminology and cross-links; migration, region and glossary pages (FIL-1570, FIL-1572) - #47

Open
filipagr wants to merge 1 commit into
filipa/docs-followups-contentfrom
filipa/docs-followups-ia
Open

filipagr wants to merge 1 commit into
filipa/docs-followups-contentfrom
filipa/docs-followups-ia

Conversation

@filipagr

Copy link
Copy Markdown
Contributor

Follow-up to #45 and #46. Stacked on #46: the base is filipa/docs-followups-content. Review after #46 and retarget as the stack merges.

FIL-1570: information architecture, terminology, SEO

  • Sidebar:
    • New Guides and Help categories. Help holds the FAQ, Troubleshooting, Contact support and Service status (status.filone.com).
    • Limits and the new Glossary sit under API Reference.
    • App is renamed Console, with short labels.
    • Generated index pages at /guides and /storage.
  • Navbar:
    • /limits no longer highlights "Documentation".
    • API Reference and SDKs & Tools now highlight on their own pages.
  • Terminology: "console" for app.filone.com. The product UI never names itself, and the docs already used "console" most. "Dashboard" stays only where it names the Dashboard page, and "left menu" / "left sidebar" became "sidebar".
  • Duplicate titles: the console pages are titled "API Keys in the console", "Buckets in the console" and "Billing in the console". Routes are unchanged.
  • Descriptions: factual descriptions replace thin ones and the marketing tagline on the introduction.
  • Repeated blocks: the endpoint table lives in reference/overview#base-endpoint, and the Governance explanation in object-lock#key-concepts. The other pages link to them.
  • Cross-links:
    • Presigned URLs and Share object link to each other.
    • Errors, Authentication and Limits link to each other.
    • Pages that ended without a next step now have Next steps.
  • Skipped: og:image, because the repo only has SVG images and og:image needs PNG or JPG.

FIL-1572: new guides (the parts that could be verified)

  • Migrate to Fil One (guides/migration):
    • Prerequisites.
    • A two-step aws s3 sync through a local folder.
    • rclone, configured with provider = Other, path-style and no_check_bucket.
    • What carries over: user metadata only with rclone -M; tags, ACLs and version history don't.
  • Choosing a region (guides/choosing-a-region): every fact comes from existing pages. It makes no latency or pricing claims.
  • Glossary (reference/glossary): 23 terms, each linking to the page that covers it.
  • Not done, because these need engineering confirmation: CORS, rate limits, durability mechanism, presigned URL maximum expiry. A changelog and the s3cmd config are also left out.

Testing

  • Local S3 emulator (moto, dummy credentials, nothing sent to Fil One or AWS):
    • The migration guide's aws s3 sync steps and rclone copy, check and multipart ran as written.
    • Object counts and sizes matched, and the metadata behaviour is as described.
  • Builds and checks: npm run build passes, and ci: build, mirror and snippet checks on every PR; docs-impact checklist #40's mirror and snippet checks pass (37 pages, 99 blocks).
  • Mirrors: the llms-full.txt page sections were regenerated, and llms.txt has the new pages and the console terminology.

Not verified

  • rclone against the real Fil One endpoints.

Merge notes

🤖 Generated with Claude Code

…ssary pages (FIL-1570, FIL-1572)

- Sidebar: Guides and Help categories, Limits and a new Glossary under API
  Reference, App renamed Console with short labels; navbar active-route
  patterns fixed for Limits, API Reference and SDKs.
- Terminology: "console" for app.filone.com ("Dashboard" only for that page),
  "sidebar" instead of left menu/sidebar.
- Unique titles for the console pages, factual descriptions for thin pages,
  endpoint table and Governance explanation each stated once, cross-links and
  Next steps on dead-end pages.
- New pages: Migrate to Fil One (aws s3 sync, rclone), Choosing a region,
  Glossary.
- Both llms mirrors updated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
filone-docs Ready Ready Preview Nov 11, 2026 9:43pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — 725cdd78 Deployed Nov 11, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant