0xMiden / 0xMiden/protocol

Automate doc build for `miden` library

Offen
#1,839 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation standards
Vorherrschende Sprache
Rust
Sterne
132
Forks
167
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
110

Beschreibung

Following the idea/approach from https://github.com/0xMiden/miden-vm/pull/2105, we should come up with a way to build docs for the `miden` protocol library automatically. It would probably result in one doc page per module, e.g. `miden::account`, `miden::tx`, etc. rather than the one page introduced in https://github.com/0xMiden/miden-base/pull/1799, but that's fine and may even be cleaner.

Two challenges here for `miden` protocol lib specifically are:
- We have a `Context` column which we either need to maintain manually or derive from the doc comments of the procedures. Deriving it from the doc comments seems best, so it's easier to maintain the correct context when reviewing code.
- Some doc comments added in https://github.com/0xMiden/miden-base/pull/1799 link to other doc pages, e.g. to explain what _recipient_ or note _metadata_ refers to. It would be ideal to keep them. Most likely, this means we should add markdown links to the MASM doc comments directly, but maybe there are other approaches.

Context: https://github.com/0xMiden/miden-base/pull/1799#pullrequestreview-3170809545

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.