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

Documentation Website #92

Open
sonicfromnewyoke opened this issue Sep 27, 2024 · 4 comments
Open

Documentation Website #92

sonicfromnewyoke opened this issue Sep 27, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@sonicfromnewyoke
Copy link

The functionality of LiteSVM is growing (geyser plugins and RPC are coming soon), so it's time to consider a dedicated documentation website like Bankrun has.

Topics I'd like to include:

  • Installation of LiteSVM & available feature-flags
  • Configuration for different purposes (testing, standalone usage etc)
  • Various examples of programs

I'll have some bandwidth after the next step of geyser's plugin implementation and can make a doc-website with zine - a zig-based static site generator, to whom I, personally, want to help grow.

Will be glad to hear your thoughts about that :)

@Aursen Aursen added the documentation Improvements or additions to documentation label Sep 28, 2024
@Aursen
Copy link
Collaborator

Aursen commented Oct 4, 2024

Your point is valid, but when it comes to doc maintenance, I don't know if it's the most practical. What do you think @kevinheavey ?

@kevinheavey
Copy link
Collaborator

Just use docs.rs

@kevinheavey
Copy link
Collaborator

If the need arises we can use mdbook like foundry does: https://book.getfoundry.sh

@Aursen
Copy link
Collaborator

Aursen commented Oct 7, 2024

Let's do a mdbook in another repo

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

No branches or pull requests

3 participants