From e6fa0958651aa333fab8988bec0d8a09fed9e1a3 Mon Sep 17 00:00:00 2001 From: GBKS Date: Tue, 25 May 2021 08:49:47 +0200 Subject: [PATCH] Add formatting info for link preview images Via #338. Also fixes a broken link in the onboarding section. --- guide/contribute/illustration-guidelines.md | 4 ++++ guide/onboarding/manual-backup.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/guide/contribute/illustration-guidelines.md b/guide/contribute/illustration-guidelines.md index 2e513349b..f0ed30abd 100644 --- a/guide/contribute/illustration-guidelines.md +++ b/guide/contribute/illustration-guidelines.md @@ -156,6 +156,10 @@ Create and specify differently laid out images for desktop and mobile as needed. Optimize your images before committing them. The easiest way is to [build and run this repository locally](https://github.com/BitcoinDesign/Guide#how-to-build-and-run-the-site-locally). Images will be automatically compressed as you add them. After compression, ensure that the quality is still acceptable. Heavily textured images are sometimes heavily compressed resulting in visible compression crystals, blurry lines and other visual artefacts. +## Link preview images + +Social and messaging services typically show a preview image when sharing links. This is a custom image that needs to be prepared and defined in the front matter of each page. The file name should combine the page name and the `-preview suffix`, for example `getting-started-preview.jpg` for the `Getting started` page. The image resolution needs to be 1200x630px for best display across social networks, both JPG and PNG file types can be used. [Twitter](https://cards-dev.twitter.com/validator) and [Facebook](https://developers.facebook.com/tools/debug/) provide handy link preview tools to check if your image turns out correctly. + --- Next, find out what options are available for formatting your content. [Take a look](/guide/contribute/formatting/). diff --git a/guide/onboarding/manual-backup.md b/guide/onboarding/manual-backup.md index 227d01f70..45e642531 100644 --- a/guide/onboarding/manual-backup.md +++ b/guide/onboarding/manual-backup.md @@ -13,7 +13,7 @@ main_classes: -no-top-padding ### How it works -It usually requires users to manually back up their 12 to 24 word recovery phrase by writing it down on a piece of paper and storing it in a safe (but memorable location). In the case that a user’s device breaks or is stolen, the user can recover their funds and wallet by correctly entering their recovery phrase. The [private key management]({{ '/guide/private-key-management/single-user-schemes/#manual-backup--recovery-phrase' | relative_url }}) section dives further into the technical details of this scheme if interested in learning more. +It usually requires users to manually back up their 12 to 24 word recovery phrase by writing it down on a piece of paper and storing it in a safe (but memorable location). In the case that a user’s device breaks or is stolen, the user can recover their funds and wallet by correctly entering their recovery phrase. The [private key management]({{ '/guide/private-key-management/manual-backup/' | relative_url }}) section dives further into the technical details of this scheme if interested in learning more. If you are designing an application that opts to use manual backups, the following sections outline how to best go about this with new users in mind.