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

Support rendering tabs in BSR markdown #3353

Closed
pd93 opened this issue Sep 28, 2024 · 2 comments
Closed

Support rendering tabs in BSR markdown #3353

pd93 opened this issue Sep 28, 2024 · 2 comments
Labels
Won't Fix Deferred tasks that are currently not addressing

Comments

@pd93
Copy link

pd93 commented Sep 28, 2024

Feature

One of the main advantages of using protobuf is that it allows users of your API to use any programming language to consume them. To this end, we'd like to be able to provide examples of usage in our docs in a variety of languages. A common way of doing this on documentation sites is to use a set of tabs (see tabs in Docusaurus for reference). This avoids clogging the page with information on languages that are irrelevant to most users.

Would you consider supporting something similar to this and/or allowing for MDX features in the BSR?

Also worth referencing this comment on a similar issue from a couple of years ago where it was mentioned that there is no good place to track BSR issues. Has this changed at all?

@pd93 pd93 added the Feature New feature or request label Sep 28, 2024
@faresbouzayen
Copy link

Hey @pd93! This feature request for rendering tabs in BSR markdown sounds fantastic! I completely agree that providing examples in multiple programming languages without cluttering the documentation would enhance usability.

Here’s how I envision implementing this:

Tab Component: Create a reusable tab component that can dynamically render content based on the selected language, similar to the tabs in Docusaurus.

Markdown Support: Extend BSR markdown parsing to support this tab structure, allowing users to easily define tabs in their markdown files.

Documentation Update: I’ll make sure to update the documentation with examples on how to implement and use this feature effectively.

Let me know if you have any specific requirements or additional ideas! I’d love to get started on this.

@perezd perezd added Won't Fix Deferred tasks that are currently not addressing and removed Feature New feature or request labels Sep 30, 2024
@perezd
Copy link
Member

perezd commented Sep 30, 2024

Thanks for the suggestion. Unfortunately, we won't be able to proceed with this request at this time, which I understand is disappointing.

@perezd perezd closed this as not planned Won't fix, can't repro, duplicate, stale Sep 30, 2024
@pd93 pd93 changed the title Support rending tabs in BSR markdown Support rendering tabs in BSR markdown Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Won't Fix Deferred tasks that are currently not addressing
Projects
None yet
Development

No branches or pull requests

3 participants