From f4f76e9661795579c2b212b75dfdcd19a271b9bc Mon Sep 17 00:00:00 2001 From: taranvohra Date: Fri, 16 May 2025 11:00:30 +0530 Subject: [PATCH] Update documentation links --- .github/CONTRIBUTING.md | 4 ++-- .github/workflows/deploy-preview.yaml | 2 +- README.md | 6 +++--- packages/gitbook/e2e/internal.spec.ts | 2 +- .../src/components/SiteLayout/RocketLoaderDetector.tsx | 2 +- packages/gitbook/tests/pagespeed-testing.ts | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a65357a23..b93b51896 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -63,9 +63,9 @@ To start your local version of GitBook, run the command `bun dev`. When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`. -For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/docs.gitbook.com` after running the development server. +For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/gitbook.com/docs` after running the development server. -You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://docs.gitbook.com/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version. +You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://gitbook.com/docs/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version. ### Commit your update diff --git a/.github/workflows/deploy-preview.yaml b/.github/workflows/deploy-preview.yaml index 4b14e3f83..7d8eec610 100644 --- a/.github/workflows/deploy-preview.yaml +++ b/.github/workflows/deploy-preview.yaml @@ -152,7 +152,7 @@ jobs: | Site | `v1` | `2v` | `2c` | | --- | --- | --- | --- | - | GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/docs.gitbook.com) | + | GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.com/docs](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.com/docs) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs) | | E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | edit-mode: replace visual-testing-v1: diff --git a/README.md b/README.md index 5a055a7a7..cbfe20a76 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

GitBook

- Docs - Community - Developer Docs - Changelog - Bug reports + Docs - Community - Developer Docs - Changelog - Bug reports

@@ -66,7 +66,7 @@ bun dev:v2 examples: -- http://localhost:3000/url/docs.gitbook.com +- http://localhost:3000/url/gitbook.com/docs - http://localhost:3000/url/open-source.gitbook.io/midjourney Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser. @@ -118,7 +118,7 @@ Encounter a bug or find an issue you'd like to fix? Helping us fix issues relate ## Deployment -> [!WARNING] +> [!WARNING] > While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need. > > _Looking to add a specific feature in GitBook? Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to get started._ diff --git a/packages/gitbook/e2e/internal.spec.ts b/packages/gitbook/e2e/internal.spec.ts index 83181c3c9..a70a7e5d8 100644 --- a/packages/gitbook/e2e/internal.spec.ts +++ b/packages/gitbook/e2e/internal.spec.ts @@ -269,7 +269,7 @@ const testCases: TestsCase[] = [ }, { name: 'GitBook', - contentBaseURL: 'https://docs.gitbook.com', + contentBaseURL: 'https://gitbook.com/docs/', tests: [ { name: 'Home', diff --git a/packages/gitbook/src/components/SiteLayout/RocketLoaderDetector.tsx b/packages/gitbook/src/components/SiteLayout/RocketLoaderDetector.tsx index 096024089..cc689bbef 100644 --- a/packages/gitbook/src/components/SiteLayout/RocketLoaderDetector.tsx +++ b/packages/gitbook/src/components/SiteLayout/RocketLoaderDetector.tsx @@ -18,7 +18,7 @@ export function RocketLoaderDetector(props: { nonce?: string }) { alert.className = 'p-4 mb-4 text-sm text-red-800 rounded-lg bg-red-50 mt-8 mx-8'; alert.innerHTML = \` Error in site configuration: - It looks like \${window.location.hostname} has been incorrectly configured in Cloudflare. This may lead to unexpected behavior or issues with the page loading. If you are the owner of this site, please refer to GitBook's documentation for steps to fix the problem. + It looks like \${window.location.hostname} has been incorrectly configured in Cloudflare. This may lead to unexpected behavior or issues with the page loading. If you are the owner of this site, please refer to GitBook's documentation for steps to fix the problem. \`; document.body.prepend(alert); diff --git a/packages/gitbook/tests/pagespeed-testing.ts b/packages/gitbook/tests/pagespeed-testing.ts index 94f48d420..07f1f01b3 100644 --- a/packages/gitbook/tests/pagespeed-testing.ts +++ b/packages/gitbook/tests/pagespeed-testing.ts @@ -12,13 +12,13 @@ interface Test { // and to be able to see the results, and only catch major regressions. const tests: Array = [ { - url: 'https://docs.gitbook.com', + url: 'https://gitbook.com/docs', strategy: 'desktop', threshold: 60, }, { - url: 'https://docs.gitbook.com', + url: 'https://gitbook.com/docs', strategy: 'mobile', threshold: 30, },