Skip to content

Comments

docs: add missing code block language to README.md#10952

Merged
slorber merged 1 commit intofacebook:mainfrom
Marukome0743:language
Feb 26, 2025
Merged

docs: add missing code block language to README.md#10952
slorber merged 1 commit intofacebook:mainfrom
Marukome0743:language

Conversation

@Marukome0743
Copy link

@Marukome0743 Marukome0743 commented Feb 26, 2025

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

Some bash scripts don't have code block language like the below.

```
$ yarn
```

Then I added the bash language name to them.

```bash
$ yarn
```

It's changes the color and style of source code to make it easier to read.

Test Plan

N/A

Test links

N/A

Related issues/PRs

N/A

@facebook-github-bot
Copy link
Contributor

facebook-github-bot commented Feb 26, 2025

Hi @Marukome0743!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@netlify
Copy link

netlify bot commented Feb 26, 2025

✅ [V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 8ca9ce5
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/67bec594d0ee1d000897b972
😎 Deploy Preview https://deploy-preview-10952--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

github-actions bot commented Feb 26, 2025

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🔴 46 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🔴 49 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 71 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 61 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 64 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 61 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 71 🟢 100 🟢 100 🟠 86 Report

@facebook-github-bot
Copy link
Contributor

facebook-github-bot commented Feb 26, 2025

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Feb 26, 2025
@slorber slorber added the pr: ignore This PR is not meaningful enough to appear in the changelog. label Feb 26, 2025
@slorber
Copy link
Collaborator

slorber commented Feb 26, 2025

Thanks

Normally we don't edit manually the examples (they are generated after a release) but not a big deal

@slorber slorber merged commit 9d7ceec into facebook:main Feb 26, 2025
5 checks passed
@Marukome0743 Marukome0743 mentioned this pull request Mar 18, 2025
Closed
facebook-github-bot pushed a commit to facebook/sapling that referenced this pull request Apr 30, 2025
@facebook-github-bot
docs: update Docusaurus README.md (#1046)
83c01b0 
Summary:
Remove [version 2 ref](facebook/docusaurus#9487) from Docusaurus [README.md](https://github.com/facebook/sapling/blob/main/website/README.md).

```diff
- This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+ This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
```

[Add `bash`](facebook/docusaurus#10952) to code block.

Pull Request resolved: #1046

Reviewed By: genevievehelsel

Differential Revision: D71368905

fbshipit-source-id: 7e8f99499f434bbc057938b43aa8365c96289317
slorber pushed a commit that referenced this pull request May 27, 2025
docs: add missing code block language to README.md (#10952)
534eca2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slorber slorber Awaiting requested review from slorber slorber is a code owner

@Josh-Cena Josh-Cena Awaiting requested review from Josh-Cena Josh-Cena is a code owner

Assignees

No one assigned

Labels

CLA Signed Signed Facebook CLA pr: ignore This PR is not meaningful enough to appear in the changelog.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Marukome0743 @facebook-github-bot @slorber