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

[EPIC] Docs Restructure #480

Closed
7 tasks done
MSevey opened this issue Oct 7, 2024 · 2 comments
Closed
7 tasks done

[EPIC] Docs Restructure #480

MSevey opened this issue Oct 7, 2024 · 2 comments
Assignees

Comments

@MSevey
Copy link
Contributor

MSevey commented Oct 7, 2024

I think there are the following user paths:

  1. Running a rollup with the rollkit CLI
  2. Building a rollup
  3. Integrating with components (da, sequencing, execution)
  4. Orchestration DevX

For 1, we have the quick start
For 2, we have wordle
For 3, I think it gets messy, because it is using GM, which jumped right into 4
For 4, We have kurtosis via the GM tutorial and the wordle tutorial, but this might not be the best place for it.

I’m wondering if for 3, we should use the quick start guide instead of GM. Then it is super clean and clear what is new with the DA integration for example.

For 4, we could have a Putting it all Together section at the bottom of the tutorial that is wordle with some base case, like Celestia DA, based sequencing, and the equivalent execution.

I think the GM tutorial is now a little out of place based on the above.

Tasks

Preview Give feedback
  1. MSevey
  2. 4 of 5
    MSevey
  3. MSevey
  4. T:documentation needs-triage
    MSevey gupadhyaya
  5. documentation
    MSevey
@MSevey MSevey added this to Rollkit Oct 7, 2024
@MSevey MSevey self-assigned this Oct 7, 2024
@MSevey MSevey converted this from a draft issue Oct 7, 2024
@MSevey MSevey changed the title Docs Restructure [EPIC} Docs Restructure Oct 8, 2024
@MSevey MSevey changed the title [EPIC} Docs Restructure [EPIC] Docs Restructure Oct 11, 2024
@MSevey
Copy link
Contributor Author

MSevey commented Oct 11, 2024

Based on learnings around how Kurtosis handles data persistence and that it is not recommended for production, I will be removing it from the docs and focusing on production ready infrastructure management.

Plan is to focus on creating helpful docker compose files since those are fine for single rollup management. It will also serve as a framework for those that plan to manage multiple rollups.

@MSevey
Copy link
Contributor Author

MSevey commented Nov 21, 2024

Closing this to just tracking the remaining clean up issues

@MSevey MSevey closed this as completed Nov 21, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Rollkit Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant