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

Contribute case studies to the guide #1022

Merged
merged 12 commits into from
Aug 11, 2023

Conversation

mouxdesign
Copy link
Collaborator

@mouxdesign mouxdesign commented Jul 6, 2023

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

👉 🎉 [Deploy preview]🎉 👈

This initial commit is a draft version of the page guiding people on how to commit a case study to the guide. To be added; header images, as well as other images.
@netlify
Copy link

netlify bot commented Jul 6, 2023

Deploy Preview for bitcoin-design-site ready!

Name Link
🔨 Latest commit 255af12
🔍 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.

@GBKS GBKS linked an issue Jul 6, 2023 that may be closed by this pull request
1. Addition of images to this PR as well 2. Change to the title
3. Nav order and next pages
Made some minor corrections to the copy here for readability.
Copy link
Contributor

@GBKS GBKS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great to see this page take shape. I left a lot of small comments, hope it's all useful.

Make sure to preview the site on your local dev environment before you commit. When the site is getting built for your preview, it also looks for new images and compresses them. The images in this PR are not compressed and pretty huge. Since they are not primarily flat shapes and lines, JPEG will also be more appropriate for a better compression.

guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/contribute.md Outdated Show resolved Hide resolved
guide/contribute/contribute.md Show resolved Hide resolved
mouxdesign and others added 3 commits July 18, 2023 01:39
Co-authored-by: Christoph Ono <chri@sto.ph>
Some changes to:
- Copy
- Previous and next links
- Internal linking
@mouxdesign
Copy link
Collaborator Author

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
Copy link
Collaborator

rabbitholiness commented Jul 21, 2023

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
Copy link
Contributor

GBKS commented Jul 21, 2023

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>

mouxdesign and others added 4 commits August 8, 2023 13:28
Co-authored-by: Christoph Ono <chri@sto.ph>
This commit is to fix some of the images wrt file names and changing them over to jpg format.
File name changes to images
Copy link
Contributor

@GBKS GBKS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of issues with images, please take another look.

_compress_images_cache.yml Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
guide/contribute/case-studies.md Show resolved Hide resolved
guide/contribute/case-studies.md Outdated Show resolved Hide resolved
mouxdesign and others added 2 commits August 11, 2023 17:21
This commit fixes some of the issues with the header and user persona images.
Copy link
Contributor

@GBKS GBKS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK. Let's get this merged. I think there could be some minor copy improvements, but those can be added in iterations as needed.

@GBKS GBKS merged commit 9092a3a into BitcoinDesign:master Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add guidelines on how to contribute a case study to the BDG
3 participants