search

BitcoinDesign / Guide

A free, open-source community resource for designers, developers and others working on non-custodial bitcoin products.
https://bitcoin.design/guide/
Other
455 stars 98 forks source link

Contribute case studies to the guide #1022

Closed mouxdesign closed 1 year ago

mouxdesign commented 1 year ago

This initial commit is a draft version of the page guiding people on how to commit a case study to the guide.

👉 🎉 [Deploy preview]🎉 👈

netlify[bot] commented 1 year ago

Deploy Preview for bitcoin-design-site ready!

Name Link
Latest commit 255af124eaf07710449d26abf0945448d4742a15
Latest deploy log https://app.netlify.com/sites/bitcoin-design-site/deploys/64d657c0b191e80008c2f861
Deploy Preview https://deploy-preview-1022--bitcoin-design-site.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mouxdesign commented 1 year ago

Thanks a lot for going through all the code Christoph. I continued to work on it and accepted the copy edits.

Also the copy/url ones that I marked as resolved I fixed those in the latest commit in a batch.

Still to work on Images.

rabbitholiness commented 1 year ago

Just went through the page. Looks good to me.

The only additional thought I had was that it might be nice to have a sample "table of contents" or "structure" in the initial section, which let's the reader quickly get an idea of what a case study should contain, before they dive into the details of the page. Something like:

Example structure

  1. How it started (Introduction)
  2. User base
  3. Methodology
  4. Insights
  5. Conclusion
  6. Resources
  7. Acknowledgement
GBKS commented 1 year ago

If you want to add a table of contents, you just need to add a bit of code, as follows:

image

{:.no_toc} tells it to not include the page title in the table of contents.

And the following snippet automatically creates a table of contents from the headers used on the page.

<div class="glossary-toc" markdown="1">
* Table of contents
{:toc}
</div>