Skip to content

Port nic device documentation to gendoc #1788

@stgraber

Description

@stgraber

The NIC device documentation (doc/reference/devices_nic.md) currently uses a static table of valid options. This should be moved to an auto-generated table using gendoc.

This is typically done in two steps:

  1. Add the required gendoc comments where the configuration options are defined (usually alongside their validator)
  2. Generate the new config metadata (make update-metadata)
  3. Update the documentation to use the generated metadata

See #847 for an example.

Metadata

Metadata

Labels

EasyGood for new contributors

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions