diff --git a/.changeset/forty-doodles-ring.md b/.changeset/forty-doodles-ring.md new file mode 100644 index 000000000..6774f08ab --- /dev/null +++ b/.changeset/forty-doodles-ring.md @@ -0,0 +1,10 @@ +--- +'@gitbook/integration-github-copilot': patch +'@gitbook/integration-segment': patch +'@gitbook/integration-github': patch +'@gitbook/integration-gitlab': patch +'@gitbook/integration-runkit': patch +'@gitbook/integration-slack': patch +--- + +Update documentation links diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 10c675c65..2f193fae8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -27,7 +27,7 @@ We recommend adding as many relevant links, minimal reproductions of the issue, If you're interested in solving an issue in our repository, start by scanning through it's exisiting issues to find one that you're interested in working on. If you find an issue to work on, you are welcome to open a PR with a fix. See the following sections below for more information on contributing for specific sections. ### Docs -The official developer docs for GitBook, hosted on https://developer.gitbook.com/. Our documentation uses one of GitBook's most useful features-[Git Sync](https://docs.gitbook.com/product-tour/git-sync)! +The official developer docs for GitBook, hosted on https://developer.gitbook.com/. Our documentation uses one of GitBook's most useful features-[Git Sync](https://gitbook.com/docs/product-tour/git-sync)! Git Sync allows you to keep your GitBook site up to date with a remote repository either on GitHub or GitLab. In our case we have the [/docs](../docs/) directory synced with https://developer.gitbook.com/. This means that any changes reviewed, approved, and merged into this directory will automatically be deployed! @@ -39,9 +39,9 @@ If you're interested in contributing to any of our already published integration ### Packages You're also welcome to contribute updates or improvements to the packages living in [/packages](../packages/). Head to each package's documentation page to learn more about what each one does. -`@gitbook/cli`: https://developer.gitbook.com/cli/quickstart -`@gitbook/api`: https://developer.gitbook.com/gitbook-api/librairies/browser-node -`@gitbook/runtime`: https://developer.gitbook.com/integrations/reference +`@gitbook/cli`: https://gitbook.com/docs/developers/integrations/reference +`@gitbook/api`: https://gitbook.com/docs/developers/gitbook-api/overview +`@gitbook/runtime`: https://gitbook.com/docs/developers/integrations/runtime ## Contributing diff --git a/bun.lockb b/bun.lockb new file mode 100755 index 000000000..fc0cdd05b Binary files /dev/null and b/bun.lockb differ diff --git a/docs/.gitbook/assets/openapi.yaml b/docs/.gitbook/assets/openapi.yaml index a99b71591..c207988c8 100644 --- a/docs/.gitbook/assets/openapi.yaml +++ b/docs/.gitbook/assets/openapi.yaml @@ -13406,7 +13406,7 @@ components: - label IntegrationContentSecurityPolicy: description: | - Security policy to validate the content of the integrations scripts and Contentkit. Will be sent as + Security policy to validate the content of the integrations scripts and Contentkit. Will be sent as headers when processing the script fetch event and the blocks fetch events. oneOf: - type: string diff --git a/docs/getting-started/guides/implement-visitor-authentication-using-next.js-and-clerk.md b/docs/getting-started/guides/implement-visitor-authentication-using-next.js-and-clerk.md index 3beb278bb..54a581948 100644 --- a/docs/getting-started/guides/implement-visitor-authentication-using-next.js-and-clerk.md +++ b/docs/getting-started/guides/implement-visitor-authentication-using-next.js-and-clerk.md @@ -1,6 +1,6 @@ # Implement Visitor Authentication using Next.js and Clerk -[Visitor Authentication](https://docs.gitbook.com/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook. +[Visitor Authentication](https://gitbook.com/docs/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook. In order to use Visitor Authentication, you'll need to configure a few tools first—Including setting up a server to handle the sign-in flow your users will go through. @@ -9,7 +9,7 @@ This guide explains how you can accomplish the above using [Next.js](https://nex The rest of this guide follows this [GitHub repository](https://github.com/GitbookIO/va-nextjs-clerk), and will explain the setup and code through the main functionalities of the demo app. {% hint style="info" %} -This feature is currently accessible to all **Pro and Enterprise** customers. If you are interested in the [Enterprise plan](https://docs.gitbook.com/account-management/plans), please contact [sales@gitbook.com](mailto:sales@gitbook.com) for a quote. +This feature is currently accessible to all **Pro and Enterprise** customers. If you are interested in the [Enterprise plan](https://gitbook.com/docs/account-management/plans), please contact [sales@gitbook.com](mailto:sales@gitbook.com) for a quote. {% endhint %} ### Clone Example @@ -124,7 +124,7 @@ After we sign in successfully, we'll then be able to navigate to our published s Visitor Authentication allows you to protect published GitBook sites behind a sign-in flow that you control. -Not only is it customizable, but it also opens up the door for many more possibilities in the future around the way you want to work in GitBook. Make sure to head to the [Visitor Authentication](https://docs.gitbook.com/publishing/visitor-authentication) docs to learn more. +Not only is it customizable, but it also opens up the door for many more possibilities in the future around the way you want to work in GitBook. Make sure to head to the [Visitor Authentication](https://gitbook.com/docs/publishing/visitor-authentication) docs to learn more. diff --git a/docs/getting-started/guides/implement-visitor-authentication-using-node.md b/docs/getting-started/guides/implement-visitor-authentication-using-node.md index 71fae9940..70d1ea3c9 100644 --- a/docs/getting-started/guides/implement-visitor-authentication-using-node.md +++ b/docs/getting-started/guides/implement-visitor-authentication-using-node.md @@ -1,6 +1,6 @@ # Implement Visitor Authentication using Node -[Visitor Authentication](https://docs.gitbook.com/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook. +[Visitor Authentication](https://gitbook.com/docs/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook. In order to use Visitor Authentication, you'll need to configure a few tools first—Including setting up a server to handle the sign-in flow your users will go through. diff --git a/docs/getting-started/guides/use-github-actions-to-translate-gitbook-pages.md b/docs/getting-started/guides/use-github-actions-to-translate-gitbook-pages.md index a8c73728e..6e031860e 100644 --- a/docs/getting-started/guides/use-github-actions-to-translate-gitbook-pages.md +++ b/docs/getting-started/guides/use-github-actions-to-translate-gitbook-pages.md @@ -12,7 +12,7 @@ Let’s dive in! ### Collections -In order to translate your site, you’ll need to have some well-organized content. GitBook provides the perfect solution to structure sites available in multiple languages: [collections](https://docs.gitbook.com/content-creation/content-structure/what-is-a-collection). +In order to translate your site, you’ll need to have some well-organized content. GitBook provides the perfect solution to structure sites available in multiple languages: [collections](https://gitbook.com/docs/content-creation/content-structure/what-is-a-collection). Collections provide a way to group related spaces together. In the context of i18n, we will use one space for each language, with a space designated to hold the content in the primary language. You can think of this space as your “main” content. @@ -30,7 +30,7 @@ After you’ve set up the collection, you can use Git Sync to enable programmati ### GitSync -[GitSync](https://docs.gitbook.com/product-tour/git-sync) is a feature in GitBook that allows you to connect a space to a remote repository hosted on either GitHub or GitLab (_starting to Git the hang of it?_). +[GitSync](https://gitbook.com/docs/product-tour/git-sync) is a feature in GitBook that allows you to connect a space to a remote repository hosted on either GitHub or GitLab (_starting to Git the hang of it?_). You can check [out our setup video](https://www.youtube.com/watch?v=Fm5hYBsRSXo) to learn more about configuring GitSync in your Space. @@ -38,7 +38,7 @@ You can check [out our setup video](https://www.youtube.com/watch?v=Fm5hYBsRSXo) **Important:** While your collection will include a space for each language in GitBook, you’ll need to connect each one to your remote repository separately. {% endhint %} -Use the [Monorepo feature](https://docs.gitbook.com/product-tour/git-sync/monorepos) if you need to configure each space to a specific folder in your remote repository. +Use the [Monorepo feature](https://gitbook.com/docs/product-tour/git-sync/monorepos) if you need to configure each space to a specific folder in your remote repository. Once you’ve connected your GitBook spaces to a remote repository, we’ll run through how to add workflows on top of your content. @@ -73,7 +73,7 @@ jobs: - uses: actions/checkout@v3 -The example action above will run every time someone merges an update to the `main` branch — which means whenever someone merges a [change request](https://docs.gitbook.com/collaboration/collaboration/change-requests) in GitBook. +The example action above will run every time someone merges an update to the `main` branch — which means whenever someone merges a [change request](https://gitbook.com/docs/collaboration/collaboration/change-requests) in GitBook. Because this workflow runs after the content is merged, it will contain up-to-date information about the request, including the latest version of the content. diff --git a/integrations/github-copilot/gitbook-manifest.yaml b/integrations/github-copilot/gitbook-manifest.yaml index 757738d37..810eb82b9 100644 --- a/integrations/github-copilot/gitbook-manifest.yaml +++ b/integrations/github-copilot/gitbook-manifest.yaml @@ -10,7 +10,7 @@ previewImages: - ./assets/gitbook-copilot-preview3.png externalLinks: - label: Documentation - url: https://docs.gitbook.com/integrations/github-copilot + url: https://gitbook.com/docs/integrations/github-copilot categories: - collaboration summary: | diff --git a/integrations/github/gitbook-manifest.yaml b/integrations/github/gitbook-manifest.yaml index 98368189c..5adc0e805 100644 --- a/integrations/github/gitbook-manifest.yaml +++ b/integrations/github/gitbook-manifest.yaml @@ -9,7 +9,7 @@ previewImages: - ./assets/github-sync.png externalLinks: - label: Documentation - url: https://docs.gitbook.com/integrations/git-sync + url: https://gitbook.com/docs/integrations/git-sync categories: - gitsync summary: | diff --git a/integrations/github/src/components.tsx b/integrations/github/src/components.tsx index 080226b5d..2dd7d4436 100644 --- a/integrations/github/src/components.tsx +++ b/integrations/github/src/components.tsx @@ -347,7 +347,7 @@ export const configBlock = createComponent< space in your repository.{' '} Learn More. @@ -374,7 +374,7 @@ export const configBlock = createComponent< from GitBook by a custom template.{' '} Learn More. @@ -456,7 +456,7 @@ export const configBlock = createComponent< Allow Pull request previews from forked respositories.{' '} Learn More. diff --git a/integrations/gitlab/gitbook-manifest.yaml b/integrations/gitlab/gitbook-manifest.yaml index 2c25a5402..ec156b929 100644 --- a/integrations/gitlab/gitbook-manifest.yaml +++ b/integrations/gitlab/gitbook-manifest.yaml @@ -9,7 +9,7 @@ previewImages: - ./assets/gitlab-sync.png externalLinks: - label: Documentation - url: https://docs.gitbook.com/integrations/git-sync + url: https://gitbook.com/docs/integrations/git-sync categories: - gitsync summary: | diff --git a/integrations/gitlab/src/components.tsx b/integrations/gitlab/src/components.tsx index ea8a29f8f..afafb1598 100644 --- a/integrations/gitlab/src/components.tsx +++ b/integrations/gitlab/src/components.tsx @@ -334,7 +334,7 @@ export const configBlock = createComponent< space in your repository.{' '} Learn more. @@ -357,7 +357,7 @@ export const configBlock = createComponent< from GitBook by a custom template.{' '} Learn more. diff --git a/integrations/runkit/gitbook-manifest.yaml b/integrations/runkit/gitbook-manifest.yaml index 221835ad4..14f73cb26 100644 --- a/integrations/runkit/gitbook-manifest.yaml +++ b/integrations/runkit/gitbook-manifest.yaml @@ -16,7 +16,7 @@ summary: | The integration allows you to embed live examples into your GitBook, removing the friction of trying new ideas. You can bring your code to life by allowing your users to run the sample of your code within your documentation. - Adding RunKit notebooks in your documentation is simple - select the RunKit block from the [command palette](https://docs.gitbook.com/tour/editor/blocks#command-palette) and insert your code snippet. + Adding RunKit notebooks in your documentation is simple - select the RunKit block from the [command palette](https://gitbook.com/docs/tour/editor/blocks#command-palette) and insert your code snippet. Or paste the link to an existing RunKit notebook into the GitBook editor to embed it in your page. # Configure diff --git a/integrations/segment/tests/events.test.ts b/integrations/segment/tests/events.test.ts index 603d6aa5f..55fddbfe4 100644 --- a/integrations/segment/tests/events.test.ts +++ b/integrations/segment/tests/events.test.ts @@ -1,6 +1,6 @@ import { describe, it, expect } from 'bun:test'; -import * as api from '@gitbook/api'; +import type * as api from '@gitbook/api'; import packageJson from '../package.json'; import { generateSegmentTrackEvent } from '../src/events'; @@ -20,7 +20,7 @@ const fakeSpaceViewEvent: api.SiteViewEvent = { fake_cookie: 'cookie', }, }, - url: 'https://docs.gitbook.com/integrations?utm_source=gitbook', + url: 'https://gitbook.com/docs/integrations?utm_source=gitbook', referrer: 'https://www.gitbook.com/', }; @@ -36,9 +36,9 @@ describe('events', () => { }, page: { referrer: 'https://www.gitbook.com/', - path: '/integrations', + path: '/docs/integrations', search: '?utm_source=gitbook', - url: 'https://docs.gitbook.com/integrations?utm_source=gitbook', + url: 'https://gitbook.com/docs/integrations?utm_source=gitbook', }, userAgent: 'fake-user-agent', ip: '127.0.0.1', diff --git a/integrations/slack/gitbook-manifest.yaml b/integrations/slack/gitbook-manifest.yaml index cbe1e6717..59746c1ec 100644 --- a/integrations/slack/gitbook-manifest.yaml +++ b/integrations/slack/gitbook-manifest.yaml @@ -11,7 +11,7 @@ previewImages: - ./assets/slack-marketplace-3.png externalLinks: - label: Documentation - url: https://docs.gitbook.com/integrations/integrations-beta/slack + url: https://gitbook.com/docs/integrations/integrations-beta/slack - label: Slack App Directory url: https://slack.com/apps/A7DE1QCTD-gitbook?tab=more_info visibility: public @@ -23,7 +23,7 @@ summary: | # Overview With the GitBook Slack integration, your teams have instant access to your documentation, and can get AI-summarized answers about your content. - [Head to our documentation to find out more](https://docs.gitbook.com/integrations/integrations-beta/slack) + [Head to our documentation to find out more](https://gitbook.com/docs/integrations/integrations-beta/slack) Slack's AI features require GitBook AI, exclusive to Pro/Enterprise plans. Free/Plus users will need to upgrade to Pro to use this integration. Please visit the [pricing page](https://www.gitbook.com/pricing) to learn more. @@ -38,7 +38,7 @@ summary: | To install on a single space, click Integrations in the sub-nav within the GitBook app. Alternatively, you can install it across all your spaces in Settings. Once you’ve installed it, head over to Slack and authorize the connection. You can select a default channel to post notifications and other messages, but remember — you can summon GitBook in any channel or thread. - [Read our documentation to learn more](https://docs.gitbook.com/integrations/integrations-beta/slack) + [Read our documentation to learn more](https://gitbook.com/docs/integrations/integrations-beta/slack) configurations: account: properties: