diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 1804457..3e879ee 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -1,6 +1,6 @@ --- title: /bloom | Documentation -description: Documentation for Bloom, the agentic Ethereum wallet mounted as a virtual filesystem. +description: Documentation for Bloom users, integrators, and developers. ---
@@ -32,26 +32,41 @@ description: Documentation for Bloom, the agentic Ethereum wallet mounted as a v } `} -/bloom walletFS is an **agentic Ethereum wallet mounted as a virtual filesystem**. +These docs serve three audiences in one place: **users** who want agents to operate crypto safely, **integrators** who want to mount and operate Bloom, and **developers** who want to build on the wallet and petal surfaces. -Reads are blockchain queries. Writes are transaction intents. The main interface is an ordinary directory that humans and agents can inspect with normal filesystem tools like `ls`, `cat`, and file writes. +:::warning +Bloom walletFS is alpha software. It is experimental and unaudited. Mainnet broadcasting is off by default; start with a local or test network and small amounts. +::: -```txt -/bloom/ - chains//... # live chain state - wallets//... # wallet state, outbox, signatures - defi/intents/... # routed DeFi plans - watch//... # live subscriptions - simulate//... # dry-run calls - tools/... # ABI, hashes, units, EIP-712 helpers -``` +## I want to use Bloom + +If you use Claude Code, Codex, Hermes, or another coding agent, start here: + +- [Start here](/use-bloom/start-here) — Bloom in plain English. +- [Is Bloom for me?](/use-bloom/is-this-for-me) — who should use it today, and who should wait. +- [Quickstart](/use-bloom/quickstart) — the shortest agent-led onboarding path. +- [FAQ](/use-bloom/faq) — supported chains, costs, keys, and the bigger picture. + +## I want to integrate Bloom + +If you are wiring Bloom into an agent environment, local machine or your existing product: + +- [Local build and mount](/integrators/quickstart) — initialize Bloom and inspect chain state. +- [Agent setup](/integrators/agent-setup) — rules and discovery commands for agents. +- [Integrating Bloom](/integrators/integrating) - learn about how you can integrate Bloom into your product. +- [Filesystem guide](/wallet/filesystem-guide) — the mounted `/bloom` tree. +- [Wallets and transactions](/wallet/wallets-and-transactions) — wallet lifecycle and staged intents. +- [Security model](/wallet/security-model) — defaults, policies, and threat boundaries. + +## I want to build on Bloom -## Start here +If you are developing Bloom itself or adding protocol capabilities: -- [What is Bloom?](/introduction/what-is-bloom) — the product model. -- [Benefits](/introduction/benefits) — why filesystem-first matters. -- [Quickstart](/getting-started/quickstart) — initialize Bloom and inspect chain state. - [Technical architecture](/reference/technical-architecture) — crates, daemon, VFS, policy, and chain integrations. +- [Supported chains](/reference/supported-chains) — chain paths and backend expectations. +- [Project map](/reference/project-map) — repos and source material behind these docs. +- [Development](/reference/development) — build, run, test, format, and lint. +- [Petals overview](/petals/overview) — protocol/capability extension model. ## The agent setup prompt @@ -61,4 +76,4 @@ For the shortest onboarding path, tell your agent: Read https://bloom.directory/SKILL.md and set up Bloom. ``` -The agent should then mount Bloom at `/bloom`, inspect the in-tree docs, explain the capabilities it found, and use Bloom instead of writing bespoke Web3 SDK code. +The agent should mount Bloom, inspect the filesystem docs, explain the capabilities it found, and use Bloom instead of asking you for private keys or writing bespoke Web3 signing code. diff --git a/src/pages/getting-started/agent-setup.mdx b/src/pages/integrators/agent-setup.mdx similarity index 100% rename from src/pages/getting-started/agent-setup.mdx rename to src/pages/integrators/agent-setup.mdx diff --git a/src/pages/integrators/integrating.mdx b/src/pages/integrators/integrating.mdx new file mode 100644 index 0000000..7e203db --- /dev/null +++ b/src/pages/integrators/integrating.mdx @@ -0,0 +1,5 @@ +# Integrating Bloom + +Bloom and walletFS can help you achieve your agentic use cases safely and quickly. + +We are actively building out this area of Bloom's product surface, so you've found us a bit early. Please reach out directly via hello@bloom.directory if you want to learn more about integrating Bloom into your existing product and we'll set up channels with our team to make it a reality. \ No newline at end of file diff --git a/src/pages/getting-started/quickstart.mdx b/src/pages/integrators/quickstart.mdx similarity index 100% rename from src/pages/getting-started/quickstart.mdx rename to src/pages/integrators/quickstart.mdx diff --git a/src/pages/introduction/benefits.mdx b/src/pages/introduction/benefits.mdx index 16ea79b..240c21e 100644 --- a/src/pages/introduction/benefits.mdx +++ b/src/pages/introduction/benefits.mdx @@ -1,6 +1,6 @@ # Benefits -Bloom is designed around the operating model agents already understand: files. +Bloom is designed around the operating model agents already understand: files. Our initial hypothesis is confirmed from early testing (not public yet): a filesystem based approach to agentic tool use spends less tokens while achieving higher tool call reliability. We plan to publish our findings soon. Other benefits include: ## For users diff --git a/src/pages/introduction/demos.mdx b/src/pages/introduction/demos.mdx new file mode 100644 index 0000000..dd867a2 --- /dev/null +++ b/src/pages/introduction/demos.mdx @@ -0,0 +1,13 @@ +# Demos + +## x402 Paid HTTP Request + +
+