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.

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

docs(bsr): proof of concept - optimizing article documentation for BSR #572

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

moritzzimmer
Copy link
Member

@moritzzimmer moritzzimmer commented Sep 11, 2024

what

restructured existing documentation of the Article messages for rendering in Buf BSR, see https://buf.build/stroeer/tapir/docs/docs/buf_bsr:stroeer.core.v1

why

  • use existing buf toolchain also for documentation
  • reduced documentation/code and ops complexity of fundoc (use standard markdown and proto comments)

added package documentation

test links

further formats

field level docs

test

field docs

documented fields map

try markdown
@moritzzimmer moritzzimmer added 📖 documentation Improvements or additions to documentation ❓question Further information is requested labels Sep 11, 2024
@moritzzimmer moritzzimmer self-assigned this Sep 11, 2024
Copy link

github-actions bot commented Sep 11, 2024

The latest Buf updates on your PR. Results from workflow proto / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedSep 17, 2024, 8:51 AM

@moritzzimmer moritzzimmer changed the title docs(bsr): PoC for optimizing documentation on BSR docs(bsr): proof of concept - optimizing article documentation for BSR Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation ❓question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant