Skip to content

v2 doc tooling #1866

@mattklein123

Description

@mattklein123

@htuch opening ticket here so we can track what we need. IMO the minimum tooling is:

  1. Build RST tree for v2 docs.
  2. Merge auto generated tree into static tree
  3. Build docs as a single block

^ will allow cross linking between auto generated docs and arch docs and vice versa. The tooling would optimally allow auto generation of the type of JSON/YAML overviews we have now, followed by some basic boiler plate param descriptions, which we could then customize via special comments inside the protos.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions