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

fix(create-docusaurus): improve init template misleading doc + add Docuaurus social card #8279

Merged
merged 4 commits into from Nov 2, 2022

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Nov 2, 2022

Fix confusing initial template docs regarding the relative image references (there's indeed an example on the target page, but this is a bit confusing for the user because the target page does not document how to use images).

Reported here: #4610 (comment)


Also replaces Docusaurus very poor social card by something a bit better.

Before:

CleanShot 2022-11-02 at 15 34 10@2x

After:

image

(far from perfect but still better than 0 text, and it's temporary until we have a better support for dynamic og images)


Growth hack: add Docusaurus social card by default to all newly initialized sites.

(Note this will only work if site owners configure their site.url correctly, but still useful)

@slorber slorber added the pr: bug fix This PR fixes a bug in a past release. label Nov 2, 2022
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 2, 2022
@slorber slorber added the to backport This PR is planned to be backported to a stable version of Docusaurus label Nov 2, 2022
@netlify
Copy link

netlify bot commented Nov 2, 2022

[V2]

Name Link
🔨 Latest commit d67397b
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/63628073e9cea50008a130b4
😎 Deploy Preview https://deploy-preview-8279--docusaurus-2.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 settings.

@github-actions
Copy link

github-actions bot commented Nov 2, 2022

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 61 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 78 🟢 100 🟢 100 🟢 100 🟢 90 Report

@netlify
Copy link

netlify bot commented Nov 2, 2022

[V2]

Name Link
🔨 Latest commit cbb2627
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/63628112d0bf9500088b0715
😎 Deploy Preview https://deploy-preview-8279--docusaurus-2.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 settings.

@netlify
Copy link

netlify bot commented Nov 2, 2022

[V2]

Name Link
🔨 Latest commit 36d844e
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/63628229d7c97b0008e054aa
😎 Deploy Preview https://deploy-preview-8279--docusaurus-2.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 settings.

@github-actions
Copy link

github-actions bot commented Nov 2, 2022

Size Change: +24 B (0%)

Total Size: 872 kB

ℹ️ View Unchanged
Filename Size Change
website/.docusaurus/globalData.json 67 kB 0 B
website/build/assets/css/styles.********.css 112 kB 0 B
website/build/assets/js/main.********.js 652 kB +8 B (0%)
website/build/index.html 40.9 kB +16 B (0%)

compressed-size-action

@slorber slorber changed the title fix: improve init template misleading doc + add Docuaurus social card fix(create-docusaurus): improve init template misleading doc + add Docuaurus social card (#8279) Nov 2, 2022
@slorber slorber changed the title fix(create-docusaurus): improve init template misleading doc + add Docuaurus social card (#8279) fix(create-docusaurus): improve init template misleading doc + add Docuaurus social card Nov 2, 2022
@slorber slorber merged commit 7a023a2 into main Nov 2, 2022
@slorber slorber deleted the slorber/init-template-improvements branch November 2, 2022 16:03
slorber added a commit that referenced this pull request Jan 26, 2023
@slorber slorber added backported This PR has been backported to a stable version of Docusaurus and removed to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backported This PR has been backported to a stable version of Docusaurus CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants