Skip to content

docs: one quickstart hub, S3 compatibility by region, tone pass (FIL-1567, FIL-1568, FIL-1569) - #46

Open
filipagr wants to merge 1 commit into
mainfrom
filipa/docs-followups-content
Open

filipagr wants to merge 1 commit into
mainfrom
filipa/docs-followups-content

Conversation

@filipagr

Copy link
Copy Markdown
Contributor

Follow-up to #45 (audit 4). Stacked on #45: the base is filipa/docs-audit-2026-11-11, so review after #45 and retarget to main when #45 merges.

FIL-1567: quickstart

  • quickstart/index is now the one hub page:
    • What you'll need
    • The real signup flow: verify email, name your organization, then the Get started page
    • Create bucket and Create API key from Get started (Read, Write and List pre-selected; Download .env saves credentials.env)
    • A credential check (aws s3 ls --profile filone) and a link to the troubleshooting table
    • Tabs for CLI, Python, JavaScript, Go and the console
  • quickstart/cli and quickstart/sdk are trimmed to setup detail, without repeating the hub. No routes removed.

FIL-1568: S3 compatibility

  • Leads with what works in both regions.
  • Bucket and object operations have eu-west-1 / us-east-1 columns instead of "region-dependent" prose.
  • The duplicated Versioning and Object Lock tables are removed. Their few unique facts moved into the main rows.
  • One Not supported table with a workaround column. Workarounds use only supported operations (for example, a scheduled ListObjectsV2 + DeleteObjects in place of lifecycle rules).
  • No test-process wording.
  • Every inbound anchor still resolves.

FIL-1569: tone

  • "no hidden costs" replaced with "No egress fees and no per-request charges".
  • The caveat that the standard S3 limits aren't confirmed for Fil One is stated once, in Limits (#standard-s3-limits). Other pages link to it.
  • Key custody is described in customer terms ("Fil One's storage provider for the region"). The fact is unchanged.
  • The deletion explanation lives once, in storage/objects#what-happens-to-deleted-data. Buckets, Object Lock and the FAQ link to it.
  • Rewritten FAQ answers:
    • Durability leads with the SLA (99.9%).
    • Integrity leads with the ETag/checksum check.
    • Backup tools: "Most S3 backup tools work", with the requirements listed.
  • Trial: upgrading lifts both caps. This was checked in the product code.

Testing

  • Product facts: checked against product origin/main 6a972b29: the signup redirects and labels, the pre-selected key permissions, the credentials.env export, and caps lifted on upgrade.
  • Local S3 emulator (moto, dummy credentials, nothing sent to Fil One): the hub's CLI flow and the Python, JS and Go programs ran end to end, and the cli page ran. go vet passes.
  • Builds and checks: npm run build passes. ci: build, mirror and snippet checks on every PR; docs-impact checklist #40's mirror and snippet checks pass (34 pages, 96 blocks).
  • Mirrors: the llms-full.txt page sections were regenerated from the pages, and the llms.txt entries for Quickstart, Encryption and S3 compatibility were updated.

Not verified

  • Whether this signup flow is deployed on app.filone.com (FIL-1576, needs a signed-in check).
  • "About 10 minutes" is an estimate.

🤖 Generated with Claude Code

…1567, FIL-1568, FIL-1569)

- Quickstart: index is the hub (signup through name organization and Get
  started, what you'll need, credential check, CLI/Python/JS/Go/console tabs);
  cli and sdk pages trimmed to setup detail.
- S3 compatibility: leads with what works, per-region columns, no duplicated
  tables, one Not supported table with workarounds, no test-process wording.
- Tone: drop "no hidden costs", state the standard-S3-limits caveat once in
  Limits, customer wording for key custody, one deletion explanation that other
  pages link to, rewritten durability/integrity/backup FAQ answers.
- 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:21pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — 383c734c 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