From eafb87dbce804d51d283893a40ba7e2ad65879e7 Mon Sep 17 00:00:00 2001 From: Pseudomata Date: Thu, 18 Jan 2024 09:30:55 -0500 Subject: [PATCH 1/2] doc: fix GitHub PR link in `getting-started.md` The 'Getting Started' documentation page has a section about replacing the GitHub PR URL with reviewstack, but the link in Markdown is parsed as GitHub flavored Markdown and shows just `facebook/react#25506` instead of `https://github.com/facebook/react/pull/25506` which is slightly confusing. This change fixes that to the full intended URL is displayed. --- website/docs/introduction/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/introduction/getting-started.md b/website/docs/introduction/getting-started.md index 3e6e476f0308e..d93288efda5a7 100644 --- a/website/docs/introduction/getting-started.md +++ b/website/docs/introduction/getting-started.md @@ -170,7 +170,7 @@ In addition to reviewing pull requests on github.com, you may also want to try [ To view a GitHub pull request on ReviewStack, take the original URL: -> https://github.com/facebook/react/pull/25506 +> [https://github.com/facebook/react/pull/25506](https://github.com/facebook/react/pull/25506) and replace the `github.com` domain with `reviewstack.dev`: From d196eb53592273aef9182bfb0449c6c4f546d40d Mon Sep 17 00:00:00 2001 From: Pseudomata Date: Thu, 18 Jan 2024 11:22:46 -0500 Subject: [PATCH 2/2] doc: wrap URL as inline code block to prevent collapsing to PR reference Wrapping the link as an inline code block prevents the GitHub flavored Markdown parsing it into a PR reference and preserves the full URL. --- website/docs/introduction/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/introduction/getting-started.md b/website/docs/introduction/getting-started.md index d93288efda5a7..14770b075bd00 100644 --- a/website/docs/introduction/getting-started.md +++ b/website/docs/introduction/getting-started.md @@ -170,11 +170,11 @@ In addition to reviewing pull requests on github.com, you may also want to try [ To view a GitHub pull request on ReviewStack, take the original URL: -> [https://github.com/facebook/react/pull/25506](https://github.com/facebook/react/pull/25506) +> [`https://github.com/facebook/react/pull/25506`](https://github.com/facebook/react/pull/25506) and replace the `github.com` domain with `reviewstack.dev`: -> https://reviewstack.dev/facebook/react/pull/25506 +> [`https://reviewstack.dev/facebook/react/pull/25506`](https://reviewstack.dev/facebook/react/pull/25506) On ReviewStack, the diff and the timeline for a pull request are displayed side-by-side rather than split across tabs. Read the [ReviewStack docs](../addons/reviewstack.md) to learn more about the various features it offers.