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

Restructues Sidebar, Highlights What to Build and Why It's Different #15

Merged
merged 3 commits into from
Oct 25, 2023

Conversation

andytudhope
Copy link
Collaborator

This PR continues to evolve the structure of the docs.

Chris and I were unhappy with the name "Developer Keys". In fact, the whole section felt out of place. It has been removed, the content there condensed, and put right after the Welcome page.

It replaces the "Design Goals", which never attracted that much attention anyway. This way, you get introduced to SUAVE, you see what cool stuff you could build, you begin to understand how that cool stuff could even be possible from a developers' perspective, and then dive into tutorials and how to guides.

I like the idea of having those novel use cases up front, because they should be the page we update most regularly as people do awesome things and the adjacent possible expands.

Work to do:

  1. Work on the specs: about 9 different points to handle there after dmarz's latest updates.
  2. Will remove/rewrite most of the how-to guides, (a) because precompiles seem likely to change and (b) probably rename "Run a computor" to "Local setup" or the like, given that we will be the people responsible for running computors on Rigil afaict.
  3. Still waiting to get my hands on either/both Foundy and Viem to help create some easy intro tutorials for devs, using tools that are familiar to them.

@vercel
Copy link

vercel bot commented Oct 19, 2023

@andytudhope is attempting to deploy a commit to the Flashbots Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented Oct 19, 2023

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

Name Status Preview Comments Updated (UTC)
suave-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2023 4:23pm

@andytudhope andytudhope merged commit 54f50e8 into flashbots:main Oct 25, 2023
1 of 2 checks passed
@andytudhope andytudhope deleted the what-how-to-build branch October 25, 2023 09:27
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