Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

File header documentation is not rendered by mkdocs #67

Open
stefan-brus-frequenz opened this issue Sep 11, 2023 · 0 comments
Open

File header documentation is not rendered by mkdocs #67

stefan-brus-frequenz opened this issue Sep 11, 2023 · 0 comments
Labels
part:docs Affects the documentation priority:❓ We need to figure out how soon this should be addressed type:bug Something isn't working

Comments

@stefan-brus-frequenz
Copy link
Contributor

stefan-brus-frequenz commented Sep 11, 2023 •
edited by llucax
Loading

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
@stefan-brus-frequenz stefan-brus-frequenz added priority:❓ We need to figure out how soon this should be addressed type:bug Something isn't working labels Sep 11, 2023
@keywordlabeler keywordlabeler bot added the part:docs Affects the documentation label Sep 11, 2023
Merged
@llucax llucax mentioned this issue Sep 11, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Feb 6, 2024
@llucax
Improve and fix documentation (#68)
d26ba0b 
- Move the service documentation to the `service` block (workaround for
#67)
- Use markdown formatting
- Use syntax highlight for examples in docs
- Add link to the RFC
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
part:docs Affects the documentation priority:❓ We need to figure out how soon this should be addressed type:bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@stefan-brus-frequenz