Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update intro, add gateway explainer, misc updates #425

Merged
merged 22 commits into from
Dec 14, 2024

Conversation

derrekcoleman
Copy link
Contributor

@derrekcoleman derrekcoleman commented Dec 6, 2024

Changes (ordered by commit history for easier cherry-picking)

Questions the Gateway Explainer page @nud3l

  • Which flows are most important to explain? This draft has five(!) step-by-step flows. I suggest we remove "User Flow" and "LP Flow", adding any detail necessary to "How Gateway Works" so it feels complete. I could see keeping the last two "Example Complex Order Flows", though.
  • Once we've decided which flows to keep, which diagrams would we like to have Craig polish? I suggest just one flow diagram that shows several strategies, similar to this one with things like "Stake for SolvBTC.BBN" added in the Strategy area:
    architecture
  • Speaking of diagrams, I lifted one from the Bitcoin Intents blog. That blog lays out great forward-looking ideas, but would we prefer to keep this docs page closer to what's live today?

Next Steps

  • Update bob/bob-gateway/README.md to point to the docs page once this PR is merged. Remove conceptual sections from README.

@derrekcoleman derrekcoleman added the documentation Improvements or additions to documentation label Dec 6, 2024
Copy link

changeset-bot bot commented Dec 6, 2024

⚠️ No Changeset found

Latest commit: 748ae61

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Dec 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bob ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 6:44pm

docs/docs/learn/introduction/stack-overview.md Outdated Show resolved Hide resolved
docs/docs/learn/builder-guides/gateway.md Show resolved Hide resolved
docs/docs/learn/builder-guides/gateway.md Outdated Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/reference/audits/index.md Show resolved Hide resolved
@derrekcoleman derrekcoleman mentioned this pull request Dec 9, 2024
60 tasks
@derrekcoleman derrekcoleman force-pushed the derrek/docs-update-gateway-roadmap branch from 9d98fc0 to 21a512c Compare December 10, 2024 23:16
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Show resolved Hide resolved
docs/docs/learn/introduction/gateway/index.md Outdated Show resolved Hide resolved
docs/docs/learn/reference/audits/index.md Show resolved Hide resolved
docs/docs/learn/introduction/gateway/strategies-v3.json Outdated Show resolved Hide resolved
Co-authored-by: Dominik Harz <[email protected]>
@nud3l nud3l merged commit 5d7ed47 into master Dec 14, 2024
4 of 5 checks passed
@nud3l nud3l deleted the derrek/docs-update-gateway-roadmap branch December 14, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants