Skip to content

feat: rewrite org profile for non-crypto developers#7

Merged
achris7 merged 2 commits into
mainfrom
feat/profile-vendor-marketplace
Jun 2, 2026
Merged

feat: rewrite org profile for non-crypto developers#7
achris7 merged 2 commits into
mainfrom
feat/profile-vendor-marketplace

Conversation

@achris7

@achris7 achris7 commented Jun 2, 2026

Copy link
Copy Markdown
Member

Strip all protocol details (contract addresses, LTV ratios, ERC-8004, matcher proxy, facilitator EOA, intent matching, oracle details). None of that matters to someone evaluating whether to use Floe.

New structure: what it does (3 steps) → vendor marketplace (27 endpoints) → install (3 lines) → make a call (one curl) → repos → frameworks. Developer lands, understands, installs.

Summary by CodeRabbit

  • Documentation
    • Reorganized README to emphasize product/usage messaging and top-level flow
    • Added a $2 free credit callout and a "Vendor Marketplace" table (27 verified endpoints)
    • Condensed component overview and updated SDK/MCP repo descriptions and install lines
    • Updated "Get started in 5 minutes" TypeScript/Python snippets to demonstrate borrowing and paid calls; added "Full quickstart" link
    • Removed deep technical "How it works" and "Protocol" sections; updated footer wording

Copilot AI review requested due to automatic review settings June 2, 2026 04:36
@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

The profile README is reorganized to prioritize marketing and hands-on usage: a "$2 free credit" callout and Vendor Marketplace appear near the top, followed by updated repos and quickstart snippets demonstrating instant_borrow and x402_fetch; a "Full quickstart" link was added and footer heading updated.

Changes

Documentation Restructuring for Marketing and Usage

Layer / File(s) Summary
Top callout, Vendor Marketplace, and Floe Stack
profile/README.md
Adds a $2 free credit marketing callout, inserts a "Vendor Marketplace — 27 verified API endpoints" section, and condenses "The Floe Stack" into a 6-component overview.
Repos and quickstart snippets (TS + Python) with borrow/payment examples
profile/README.md
Updates the "Repos" table rows/descriptions and install/setup lines; modifies the TypeScript quickstart to show instant_borrow and x402_fetch (with updated example URL/body); adjusts the Python borrow snippet and inserts a "Full quickstart" link after the MCP block.
Remove protocol/financial-loop and update footer heading
profile/README.md
Deletes the "How it works — the full financial loop" section and the Protocol table; updates footer subheading to "Credit and payments for the agent economy."

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • Floe-Labs/.github#6: Both modify profile/README.md vendor marketplace section and x402 endpoint/facilitator wording.
  • Floe-Labs/.github#5: Both add/adjust the centered $2 free credit (~200 API calls) callout and place it within the README structure.
  • Floe-Labs/.github#2: Both update quickstart snippets demonstrating instant_borrow and x402_fetch and reorganize landing content.

Poem

A README rewrote, bright on the shelf,
A rabbit hops in to tweak how you’ll help,
Quickstarts that borrow, and endpoints to pay,
Vendors parade, and links guide the way,
Credits and docs — hop, launch, and play. 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: rewrite org profile for non-crypto developers' accurately reflects the main objective of the PR: streamlining the organization profile to be more accessible to non-crypto developers by removing protocol-specific details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/profile-vendor-marketplace

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Rewrites the org profile README to target developers unfamiliar with crypto, stripping protocol-level details and focusing on a simple "what it does → install → call" flow.

Changes:

  • Replaces the protocol/stack tables (ERC-8004, LTV, facilitator addresses, etc.) with a 3-step "What Floe does" section.
  • Adds a vendor marketplace table (27 endpoints) and a simple curl example for a paid API call.
  • Condenses install, repos, framework support, and footer links into briefer sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…ternals

Add Vendor Marketplace section (27 verified endpoints, 7 categories).
Remove protocol internals (contract addresses, LTV ratios, facilitator
EOA, matcher proxy, oracle details, ERC-8004 spec references) — these
belong in docs, not the org profile.

Keep: framework table, code examples (TS/Python/MCP), stack table,
repos, links, $2 free credit CTA.

Reword stack table to avoid crypto jargon: "on-chain collateral" →
"your deposit", "ERC-8004 identity" → removed, "per-loan isolated
escrow" → removed.
@achris7 achris7 force-pushed the feat/profile-vendor-marketplace branch from c2b7afe to d1b3ee5 Compare June 2, 2026 04:39

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@profile/README.md`:
- Around line 55-58: The fenced code block starting with "```bash" in README.md
lacks a preceding blank line; insert a single blank line immediately before that
fenced code block (the line containing "```bash") so the Markdown renderer
treats the block correctly and follows Markdown best practices.
- Around line 60-63: Add a blank line immediately before the fenced code block
starting with ```bash that contains "pip install floe-agentkit-actions" so the
Markdown has an empty line separating the preceding paragraph and the code
block; update the README.md so the fenced block is preceded by one blank line
(and ensure there is still a closing ``` after the command).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6d6b4917-377b-4a20-a338-c4686a63c094

📥 Commits

Reviewing files that changed from the base of the PR and between 1d426c1 and c2b7afe.

📒 Files selected for processing (1)
  • profile/README.md

Comment thread profile/README.md Outdated
Comment thread profile/README.md Outdated
@achris7

achris7 commented Jun 2, 2026

Copy link
Copy Markdown
Member Author

@copilot resolve the merge conflicts in this pull request

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request

Resolved in d5bb07b.

@achris7 achris7 merged commit 7373961 into main Jun 2, 2026
1 check passed
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.

3 participants