ethereum / ethereum/verkle-dev-website

Template for documentation

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
12
Forks
12
PR merge metrics
No merged PRs in 30d

Description

We only require two things for a template:

- Latex support
- Chapter support
- Code inlining

It would be nice to have interactive code, but it is not needed.

I am leaning towards using mdbook as it is what I am familiar with.

Example sites using mdbook:

- doubleodd.group
- ristretto.group

Contributor guide

No contributing guide indexed for this repository

Research direction

No file or test is named. Start by reviewing the repository's current documentation setup and comparing mdBook with the referenced example sites; done means choosing a template that supports LaTeX, chapters, and inline code, with interactive code remaining optional.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.