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

[Meta] Standardize exporters docs #3559

Closed
5 of 11 tasks
svrnm opened this issue Nov 17, 2023 · 6 comments
Closed
5 of 11 tasks

[Meta] Standardize exporters docs #3559

svrnm opened this issue Nov 17, 2023 · 6 comments
Labels
0-meta help wanted Extra attention is needed

Comments

@svrnm
Copy link
Member

svrnm commented Nov 17, 2023

Description

Based on #3355 all exporter pages should follow a similar structure (where applicable). In a second step we can extract common text blocks into snippets managed at one place.

How you can help

Take a language of your choice and use the structure of the JavaScript Exporters page as template (the "browser" part is not applicable for other languages and can be skipped)

@svrnm svrnm added help wanted Extra attention is needed good first issue Good for newcomers 0-meta labels Nov 17, 2023
@justankiit
Copy link

I would also love to add value on this issue!

@svrnm
Copy link
Member Author

svrnm commented Nov 20, 2023

I would also love to add value on this issue!

Thanks @kumarankit999, what's a language you feel comfortable with tackling?

cartermp added a commit that referenced this issue Nov 22, 2023
fixes #3550 as a stopgap

Eventually, we'll want to rewrite this page in accordance with #3559, but for now this addresses a known point of confusion.
@kennykguo
Copy link

if this issue is still active, please assign this issue to me, thanks

@svrnm
Copy link
Member Author

svrnm commented Feb 20, 2024

@kennykguo this is a meta issue, which will not be assigned. You can take a look at an individual language and see if you can help with that.

@justankiit
Copy link

I would like to work in GO!

@svrnm
Copy link
Member Author

svrnm commented Feb 22, 2024

@kumarankit999 that's great to hear! Please take a look at some of the docs that are completed already (Python, C++, JS. Pick one as your starting point, pick the underlying markdown file and build the updated version from there.

You can also take a look at this ongoing PR for .NET to see how you can tackle this:

#4016

Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0-meta help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants