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: add quickstart, dark mermaid theme, etc #1537

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

carver
Copy link
Collaborator

@carver carver commented Oct 19, 2024

What was wrong?

There was no Quickstart to get a user quickly using trin.

How was it fixed?

  • Simplified the intro page
  • Added a new Quickstart page immediately after the intro
  • Moved Portal Network concepts to a new Concepts chapter
  • Switch mermaid diagrams to use dark theme, which better matches the book theme (it was hard to see diagram arrows)
  • Cleaned up a content network search diagram that incorrectly added a network hop

Unrelated: ignore ctags created by rusty-tags

To-Do

- Simplified the intro page
- Kicked off a Quickstart page
- Moved Portal Network concepts to a new Concepts chapter
- Switch mermaid diagrams to use dark theme, which better matches the
  book theme (it was hard to see diagram arrows)
- Cleaned up a content network search diagram that incorrectly added a
  network hop

Unrelated: ignore ctags created by rusty-tags

Launch the executable with 2GB local disk space:
```sh
./trin --portal-subnetworks state,history --mb 2000
Copy link
Collaborator Author

@carver carver Oct 19, 2024

Choose a reason for hiding this comment

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

Maybe I'll delay merging this PR, to enable state by default and then remove this flag

Edit: opened #1538

@carver carver requested a review from njgheorghita October 19, 2024 04:24
@carver carver self-assigned this Oct 19, 2024
Copy link
Collaborator

@njgheorghita njgheorghita left a comment

Choose a reason for hiding this comment

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

good to 🚢 once #1538 is resolved

@carver
Copy link
Collaborator Author

carver commented Oct 22, 2024

Looks like we're not turning on state by default for a while, so I'll merge this as-is.

@carver carver merged commit bb5bcac into ethereum:master Oct 22, 2024
12 checks passed
@carver carver deleted the add-quickstart branch October 22, 2024 20:09
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.

2 participants