Add an examples explanation contribution page #1949
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alice-i-cecile
added
X-Controversial
Henauxg
approved these changes
Apr 16, 2025
Co-authored-by: Gilles Henaux <[email protected]>
Co-authored-by: Gilles Henaux <[email protected]>
Henauxg
approved these changes
Apr 22, 2025
Co-authored-by: Gilles Henaux <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a style guide for writing explanations for examples, designed following conversations12 in the discord and the development of doup's docs extraction.
This is an edited version of the hackMD document (which featured 3 examples) that I've posted to the discord a few times, to make it a bit closer to the surrounding contribution guide.
This PR needs some more feedback, there's divergence from the writing docs guide in terms of "who is looking at this" that I'm not sure is necessary, and some things may have been cut from the hackMD doc that shouldn't have been.
Footnotes
(original conversation) https://discord.com/channels/691052431525675048/1316318586247315487/1316384953390600223 ↩
(more recent feedback) https://discord.com/channels/691052431525675048/743559241461399582/1331017971862208590 ↩