Create Contribute Section by pavlenex · Pull Request #109 · BitcoinDesign/Guide

pavlenex · 2021-01-11T19:04:46Z

This PR is a successor of #103 due to changes that will happen in #108

Overview

This PR:

Creates a new section Contribute
Moves certain part of Resources to Contribute (including images)
Creates a new Contribute.md in the contribute and in the folder, that should serve as the starting page.
Edits content in Content Guidelines.md (condenses info, grammar fixes and new content, quite re-structured but not from the grounds up)
Edits and formats "Formatting.md`

pavlenex · 2021-01-12T17:07:56Z

This PR should now be ready for a review.

There are few more things left, that I'd like to tackle in a separate PR, to keep changes to minimal so that this or other pull requests don't require larger rebasing.

To-Do

If this PR gets merged, I will do following things in the next one:

Create "How to submit.md" as per discussion here
Create "target-audience.md` and add link to Google Doc in progress
Add example template when creating a brand-new page.

Consequence of this PR

We will have 2 Contribute CTA one in the header and one in the sidebar when somebody views /guide which may be weird?
Resources section is now empty, but should be filled in after Adds a new page about application interoperability #108
Picture added as an example in content-guideline.md will be visible after WIP: Coin Selection Page #90 is merged.

Also feel free to squash the commits when merging, I may have over-done it as I tried to fix few visual things.

johnsBeharry

Looks good to me. Awesome work @pavlenex and very much needed.

Apply GBKS's suggestions. Co-authored-by: Christoph Ono <chri@sto.ph>

pavlenex · 2021-01-13T13:52:12Z

@johnsBeharry I've committed @GBKS's suggestions. Should be good to go now, but we may want #108 merged in first ,so that I can re-base if needed.

Co-authored-by: Christoph Ono <chri@sto.ph>

* Set up foundation resources vs contribute * Update formatting.md * add contribute.md * Update content-guidelines.md * Update contribute.md * add examples do's and don't * formatting * replace blockquote with italic styling * add example of graphical context * Add better structure to formatting with examples * Update formatting.md * re-structure and add lists * image formatting * re-structure * add html tag * Update formatting.md * try plaintext * replace html with markdown * Update content-guidelines.md * better link example * add yt video instructions * liquid raw format, remove encoded img code * attempt to fix {% raw %} * Added Contribute page preview image * Apply suggestions from code review Apply GBKS's suggestions. Co-authored-by: Christoph Ono <chri@sto.ph> * Apply suggestions from code review Co-authored-by: Christoph Ono <chri@sto.ph> * Remove Resources.md and img folder * add footnote, fix figma, move code block * Update formatting.md * Add minimal info on slack channel and github to guide contribution page * Change nav title to 'Contribute to Guide' * Make *the* reader.... * Bump subheader formatting to differentiate from Do's/Dont's * Put 'Do's ahead of 'Don't's * *most* people *scan*... * Simplify language * Tweaks to language * tweaks, add reference to markdown. * Revert "tweaks, add reference to markdown." This reverts commit 6b0ed53. * Break * Typos * Figma embed tweaks. * Footnote tweaks * are you -> you are * Revert nav title change (too long) * Revert "Revert nav title change (too long)" This reverts commit f405401. * Fix parent names * Update guide/contribute/contribute.md Co-authored-by: Christoph Ono <chri@sto.ph> * Update guide/contribute/contribute.md Co-authored-by: Christoph Ono <chri@sto.ph> * Update guide/contribute/contribute.md Co-authored-by: Christoph Ono <chri@sto.ph> * Fix parent: Co-authored-by: Pavlenex <pavlenex@btcpayserver.org> Co-authored-by: GBKS <chri@sto.ph> Co-authored-by: Daniel Nordh <>

pavlenex added 21 commits January 11, 2021 19:41

Set up foundation resources vs contribute
815563a

Update formatting.md
21b534c

add contribute.md
d20f22a

Update content-guidelines.md
f1f2937

Update contribute.md
8f3fb8d

add examples do's and don't
411819f

formatting
e9c56fd

replace blockquote with italic styling
5b68dd1

add example of graphical context
14419ee

Add better structure to formatting with examples
1ee9ded

Update formatting.md
242da74

re-structure and add lists
b931791

image formatting
d3a3f4b

re-structure
b1a3643

add html tag
f3d0b48

Update formatting.md
4a75454

try plaintext
3fb081d

replace html with markdown
5914984

Update content-guidelines.md
d63035d

better link example
b0546b5

add yt video instructions
b65120b

johnsBeharry reviewed Jan 12, 2021
View reviewed changes

Comment threadguide/contribute/formatting.md Outdated
Comment threadguide/contribute/formatting.md Outdated

pavlenex added 2 commits January 12, 2021 23:55

liquid raw format, remove encoded img code
0003c80

attempt to fix {% raw %}
8393231

johnsBeharry approved these changes Jan 13, 2021
View reviewed changes