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: create new gateway strategy #466

Draft
wants to merge 2 commits into
base: feat/add_gateway_interfaces_plus_tests
Choose a base branch
from

Conversation

derrekcoleman
Copy link
Contributor

@derrekcoleman derrekcoleman commented Jan 27, 2025

  • Creates a docs page for the process of making new gateway strategies
  • Adds Contracts docgen back for Gateway files
Screenshot 2025-01-27 at 8 54 45 AM

TODO:

  • Reduce docgen scope to Gateway only
  • Finish hyperlinks in gateway page
  • Add cross-linking to Gateway and Gateway SDK pages
  • Reorganize pages within Builder guide section

Nomenclature Questions for the PR:

  • “Gateway” or “BOB Gateway”?
  • “BOB SDK” or “Gateway SDK”?
  • Where should "Contracts" go? It's nested deeply, but I prefer to keep everything in one sidebar rather than reintroduce it to the navbar
  • Is it time to make an SDK section below Builder Guides with link in Navbar?

@derrekcoleman derrekcoleman added the documentation Improvements or additions to documentation label Jan 27, 2025
@derrekcoleman derrekcoleman self-assigned this Jan 27, 2025
Copy link

changeset-bot bot commented Jan 27, 2025

⚠️ No Changeset found

Latest commit: e2b427c

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 Jan 27, 2025

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 Jan 27, 2025 3:57pm

@derrekcoleman derrekcoleman mentioned this pull request Jan 27, 2025
62 tasks
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.

1 participant