Skip to content

HTML docs - #292

Draft
diondokter wants to merge 5 commits into
masterfrom
docs-output
Draft

HTML docs#292
diondokter wants to merge 5 commits into
masterfrom
docs-output

Conversation

@diondokter

@diondokter diondokter commented Aug 22, 2026

Copy link
Copy Markdown
Owner

Closes #87

Idea is:

  • Generate multiple files, one per object (rustdoc style)
  • With javascript, be able to convert bytes into field values and vice versa (calculator)
  • Playground should be able to inspect the html but also render the html

Open questions:

  • Should we just specify all doc comments are markdown and then render the markdown?
  • Do we want to support no-js operations?
  • What about search?
  • Do we need a pdf-friendly version (so no calculator elements)?

Not everything needs to be done in this PR though.

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.

Generate an HTML overview

1 participant