-
-
Notifications
You must be signed in to change notification settings - Fork 417
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
No indication on standard lib site how to contribute #1829
Comments
Hi! I'd love to help with this. However, I'm not sure where I would need to add this information in order to make it appear above the list of Packages on the main page of the stdlib documentation. Can you point me in the right direction? |
(Alternately perhaps it needs to go in the tutorial somewhere?) |
@Pyrrh awesome. So... there's documentation generation for the standard library built into the pony compiler. It first does regular documentation generation using the
If you generate Having a general "header" after the You could add content in Hopefully this makes sense. If not now, then once you get started. |
@SeanTAllen I started work on this, but there is no longer a I was able to get the docs locally by following the steps in CI so I can make progress tonight, but wanted to note the lack of |
@rhagenson intentional. |
I see. Where would be the correct place to then add this "How to contribute" content so it appears on the index page? |
It would have to be part of the script that creates the docs to update the generated mkdocs to include some additional content. |
Okay. Similar to how it was done back when the |
Its not reasonable for us to assume that when people find gaps in the standard library documentation that they know they can contribute by opening a PR here. That should be included in standard library doc site.
The text was updated successfully, but these errors were encountered: