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

docs: improve the opening sentence's clarity #9177

Merged
merged 1 commit into from
Jul 27, 2023

Conversation

oluwatobiss
Copy link
Contributor

@oluwatobiss oluwatobiss commented Jul 26, 2023

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

The current opening sentence of the Contributing Guide could be clearer. Here's a comparison of the existing text and the proposed:

  • Existing: Docusaurus is our way to hopefully help to create open source documentation easier.
  • Proposed: Docusaurus is our way to hopefully help make open source documentation easier.

Test Plan

N/A (This is a doc update)

Test links

Deploy preview: https://deploy-preview-9177--docusaurus-2.netlify.app/

Related issues/PRs

N/A

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jul 26, 2023
@netlify
Copy link

netlify bot commented Jul 26, 2023

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit c88b5e8
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/64c06f24b284890008352959
😎 Deploy Preview https://deploy-preview-9177--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 configuration.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 87 🟢 97 🟠 83 🟢 100 🟠 89 Report
/docs/installation 🟠 77 🟢 100 🟠 83 🟢 100 🟠 89 Report

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Jul 27, 2023
@slorber slorber merged commit 2276dfb into facebook:main Jul 27, 2023
@oluwatobiss oluwatobiss deleted the patch-1 branch July 27, 2023 13:57
slorber pushed a commit to VinceCYLiao/docusaurus that referenced this pull request Aug 3, 2023
This was referenced Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants