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

Add ecash section to guide #1093

Merged
merged 191 commits into from
Dec 3, 2024
Merged

Conversation

swedishfrenchpress
Copy link
Contributor

@swedishfrenchpress swedishfrenchpress commented May 19, 2024

Hey @GBKS @mouxdesign @danielnordh.

I am working on the ecash section for the design guide. I have some foundations laid down and would like to submit a Draft PR so I can preview it in a test environment.

I would like to keep pushing changes to the draft PR regularly as I will be adding illustrations, updating copy, moving things around etc...

I'm still rather new to this process so please let me know what are the best practices here.

Preview

Copy link

netlify bot commented May 19, 2024

Deploy Preview for bitcoin-design-site ready!

Name Link
🔨 Latest commit ba2f380
🔍 Latest deploy log https://app.netlify.com/sites/bitcoin-design-site/deploys/674db9ebd3d6750008bda7db
😎 Deploy Preview https://deploy-preview-1093--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.

Removed old illustration. Added notes for future illustrations.
@swedishfrenchpress swedishfrenchpress marked this pull request as draft May 20, 2024 16:24
@swedishfrenchpress swedishfrenchpress changed the title Draft PR: Ecash Add ecash section to guide May 20, 2024
@swedishfrenchpress swedishfrenchpress marked this pull request as ready for review November 18, 2024 12:15
guide/how-it-works/ecash/introduction.md Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Show resolved Hide resolved
guide/how-it-works/ecash/fedimint.md Show resolved Hide resolved
guide/how-it-works/ecash/fedimint.md Show resolved Hide resolved
guide/how-it-works/ecash/fedimint.md Show resolved Hide resolved
guide/how-it-works/ecash/fedimint.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/fedimint.md Show resolved Hide resolved
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.

Tons of progress since I last reviewed. It's looking really great.

There's some more minor formal stuff that I noticed that should be tweaked, such as:

  • Removing the unused images_backup in cashu.md
  • Making title capitalization consistent to sentence case (pages use a mix right now, sentence case is guide standard)
  • Remove link to Mutiny Wallet, since that product is being shut down
  • improveme typo at the top of the design practices page
  • Next link on design practices page would go to private key management
  • Don't define mobile and mobileRetina images if it's just the same as the non-retina image
  • Page titles, editor's notes and next sentences at the bottom state that the pages are an introduction, a detailed summary, and a technical deep-dive. Need to pick one.
  • recieves typo and duplicate image captions in the design practices page

I did not try to make a comprehensive list, so there's probably some more. But I think all this can be easily done in a follow-up PR.

The one thing that I think should be done before merging this one is to compress all the images (using ImageOptim, for example). You can reduce them by ~60%. That will help a lot with page load times. Doing that pre-merge keeps our repo history a little cleaner.

After that, maybe also resolve the ~30 unresolved conversations, and set up a follow-up PR for some of the fine-grained stuff. Let's get this thing out the door.

Congrats, sorry, and thanks for dealing with almost 350 comments on this PR. It's a beast.

@swedishfrenchpress
Copy link
Contributor Author

  • Removing the unused images_backup in cashu.md
    • Done
  • Making title capitalization consistent to sentence case (pages use a mix right now, sentence case is guide standard)
    • Done
  • Remove link to Mutiny Wallet, since that product is being shut down
    • Done
  • improveme typo at the top of the design practices page
    • Fixed
  • Next link on design practices page would go to private key management
    • Done
  • Don't define mobile and mobileRetina images if it's just the same as the non-retina image
    • Each image file (image, retina, mobile, mobile retina) is different. The sizes vary between mobile and non-mobile, and the resolution differs between retina and non-retina versions. I followed the same conventions as the other pages.
  • Page titles, editor's notes and next sentences at the bottom state that the pages are an introduction, a detailed summary, and a technical deep-dive. Need to pick one.
    • Fixed. Also added a link to the Figma illustration sources.
  • recieves typo and duplicate image captions in the design practices page
    • Fixed

I also went back and made updates to the comments you left in September. I made the updates, left a comment, and resolved the comments.

I also ran all the images through ImageOptim. That made a huge difference. Saved a total of 6.2 MB. Thanks for sharing this tool.

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.

Handful of minor tweaks still. Then let's go.

guide/how-it-works/ecash/cashu.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/design-best-practices.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/design-best-practices.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/design-best-practices.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/cashu.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Outdated Show resolved Hide resolved
guide/how-it-works/ecash/introduction.md Outdated Show resolved Hide resolved
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 go!

@danielnordh
Copy link
Contributor

ACK. Let's merge!

@GBKS GBKS merged commit 5bab83c into BitcoinDesign:master Dec 3, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
How it works Referring to the How it works section.
Projects
Development

Successfully merging this pull request may close these issues.

10 participants