Skip to content

Document config.toml options automatically #5898

@wileyj

Description

@wileyj

Current config options could use better (automatic) documentation, i.e. via rustdoc.
Code comments would be welcome so it's clear what each option does (some are in a good state, but not all) - as well as removing microblock config options.

Once that generation step is done, we can then automate a process to build the docs on release (similar to clarity functions/types), which are then PR'ed to the docs repo (cc @BowTiedDevOps for visibility, who's working on a process for that on the clarity functions).

Metadata

Metadata

Assignees

Labels

featureBrand new functionality. New pages, workflows, endpoints, etc.good first issueAppropriate for a new open source contribution.locked

Type

No type

Projects

Status

Status: ✅ Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions