Skip to content

File header documentation is not rendered by mkdocs #67

@stefan-brus-frequenz

Description

@stefan-brus-frequenz

What happened?

Sadly the file-level documentation is not rendered at all by pseudomuto/protoc-gen-doc.

Since this is very important info it would be nice to include it somewhere else. Maybe as part of the service block documentation?

What did you expect instead?

File header documentation should be moved to the service documentation until the issue is fixed upstream.

Affected version(s)

No response

Affected part(s)

Documentation (part:docs)

Extra information

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:docsAffects the documentationpriority:❓We need to figure out how soon this should be addressedtype:bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions