From a6c25ab7d38b9667a42f03d6c111a737bb80b841 Mon Sep 17 00:00:00 2001 From: dillonstreator Date: Mon, 19 Aug 2024 05:21:50 -0500 Subject: [PATCH] docs: update documentation references to include `/docs` base path (#16257) * docs: update /doc references * gix avilibilty docs link --------- Co-authored-by: unknown --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- apps/api/v1/pages/api/availabilities/[id]/_delete.ts | 2 +- apps/api/v1/pages/api/availabilities/[id]/_get.ts | 2 +- apps/api/v1/pages/api/availabilities/[id]/_patch.ts | 2 +- apps/api/v1/pages/api/availabilities/_post.ts | 2 +- apps/api/v1/pages/api/docs.ts | 4 ++-- apps/api/v1/pages/api/event-types/[id]/_delete.ts | 2 +- apps/api/v1/pages/api/event-types/[id]/_get.ts | 2 +- apps/api/v1/pages/api/event-types/[id]/_patch.ts | 2 +- apps/api/v1/pages/api/event-types/_get.ts | 2 +- apps/api/v1/pages/api/event-types/_post.ts | 2 +- apps/api/v1/pages/api/teams/[teamId]/event-types/_get.ts | 2 +- apps/api/v1/pages/api/webhooks/[id]/_delete.ts | 2 +- apps/api/v1/pages/api/webhooks/[id]/_get.ts | 2 +- apps/api/v1/pages/api/webhooks/[id]/_patch.ts | 2 +- apps/api/v1/pages/api/webhooks/_get.ts | 2 +- apps/api/v1/pages/api/webhooks/_post.ts | 2 +- 17 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0788fabc58..87c308d71b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,7 +12,7 @@ ## Mandatory Tasks (DO NOT REMOVE) - [ ] I have self-reviewed the code (A decent size PR without self-review might be rejected). -- [ ] I have added a Docs issue [here](https://github.com/calcom/docs/issues/new) if this PR makes changes that would require a [documentation change](https://docs.cal.com). If N/A, write N/A here and check the checkbox. +- [ ] I have added a Docs issue [here](https://github.com/calcom/docs/issues/new) if this PR makes changes that would require a [documentation change](https://docs.cal.com/docs). If N/A, write N/A here and check the checkbox. - [ ] I confirm automated tests are in place that prove my fix is effective or that my feature works. ## How should this be tested? diff --git a/apps/api/v1/pages/api/availabilities/[id]/_delete.ts b/apps/api/v1/pages/api/availabilities/[id]/_delete.ts index 9c5539add4..be891c7685 100644 --- a/apps/api/v1/pages/api/availabilities/[id]/_delete.ts +++ b/apps/api/v1/pages/api/availabilities/[id]/_delete.ts @@ -27,7 +27,7 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform * tags: * - availabilities * externalDocs: - * url: https://docs.cal.com/availability + * url: https://docs.cal.com/docs/core-features/availability * responses: * 201: * description: OK, availability removed successfully diff --git a/apps/api/v1/pages/api/availabilities/[id]/_get.ts b/apps/api/v1/pages/api/availabilities/[id]/_get.ts index aeb41de90e..248aa11949 100644 --- a/apps/api/v1/pages/api/availabilities/[id]/_get.ts +++ b/apps/api/v1/pages/api/availabilities/[id]/_get.ts @@ -28,7 +28,7 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform * tags: * - availabilities * externalDocs: - * url: https://docs.cal.com/availability + * url: https://docs.cal.com/docs/core-features/availability * responses: * 200: * description: OK diff --git a/apps/api/v1/pages/api/availabilities/[id]/_patch.ts b/apps/api/v1/pages/api/availabilities/[id]/_patch.ts index 87cd787b93..66fc949add 100644 --- a/apps/api/v1/pages/api/availabilities/[id]/_patch.ts +++ b/apps/api/v1/pages/api/availabilities/[id]/_patch.ts @@ -63,7 +63,7 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform * tags: * - availabilities * externalDocs: - * url: https://docs.cal.com/availability + * url: https://docs.cal.com/docs/core-features/availability * responses: * 201: * description: OK, availability edited successfully diff --git a/apps/api/v1/pages/api/availabilities/_post.ts b/apps/api/v1/pages/api/availabilities/_post.ts index 2e0a8e1247..1cd6b2e7e8 100644 --- a/apps/api/v1/pages/api/availabilities/_post.ts +++ b/apps/api/v1/pages/api/availabilities/_post.ts @@ -62,7 +62,7 @@ import { * tags: * - availabilities * externalDocs: - * url: https://docs.cal.com/availability + * url: https://docs.cal.com/docs/core-features/availability * responses: * 201: * description: OK, availability created diff --git a/apps/api/v1/pages/api/docs.ts b/apps/api/v1/pages/api/docs.ts index 0619965535..e0f33493d6 100644 --- a/apps/api/v1/pages/api/docs.ts +++ b/apps/api/v1/pages/api/docs.ts @@ -11,8 +11,8 @@ const swaggerHandler = withSwagger({ { url: "https://api.cal.com/v1" }, ], externalDocs: { - url: "https://docs.cal.com", - description: "Find more info at our main docs: https://docs.cal.com/", + url: "https://docs.cal.com/docs", + description: "Find more info at our main docs: https://docs.cal.com/docs/", }, info: { title: `${pjson.name}: ${pjson.description}`, diff --git a/apps/api/v1/pages/api/event-types/[id]/_delete.ts b/apps/api/v1/pages/api/event-types/[id]/_delete.ts index 40a90db5f3..62ad8e13b6 100644 --- a/apps/api/v1/pages/api/event-types/[id]/_delete.ts +++ b/apps/api/v1/pages/api/event-types/[id]/_delete.ts @@ -28,7 +28,7 @@ import { schemaQueryIdParseInt } from "~/lib/validations/shared/queryIdTransform * tags: * - event-types * externalDocs: - * url: https://docs.cal.com/core-features/event-types + * url: https://docs.cal.com/docs/core-features/event-types * responses: * 201: * description: OK, eventType removed successfully diff --git a/apps/api/v1/pages/api/event-types/[id]/_get.ts b/apps/api/v1/pages/api/event-types/[id]/_get.ts index 6410a47b0f..a4e4bad3ac 100644 --- a/apps/api/v1/pages/api/event-types/[id]/_get.ts +++ b/apps/api/v1/pages/api/event-types/[id]/_get.ts @@ -34,7 +34,7 @@ import getCalLink from "../_utils/getCalLink"; * tags: * - event-types * externalDocs: - * url: https://docs.cal.com/core-features/event-types + * url: https://docs.cal.com/docs/core-features/event-types * responses: * 200: * description: OK diff --git a/apps/api/v1/pages/api/event-types/[id]/_patch.ts b/apps/api/v1/pages/api/event-types/[id]/_patch.ts index 1e17c21d31..99185cba53 100644 --- a/apps/api/v1/pages/api/event-types/[id]/_patch.ts +++ b/apps/api/v1/pages/api/event-types/[id]/_patch.ts @@ -194,7 +194,7 @@ import checkTeamEventEditPermission from "../_utils/checkTeamEventEditPermission * tags: * - event-types * externalDocs: - * url: https://docs.cal.com/core-features/event-types + * url: https://docs.cal.com/docs/core-features/event-types * responses: * 201: * description: OK, eventType edited successfully diff --git a/apps/api/v1/pages/api/event-types/_get.ts b/apps/api/v1/pages/api/event-types/_get.ts index 1db594350a..e3160da894 100644 --- a/apps/api/v1/pages/api/event-types/_get.ts +++ b/apps/api/v1/pages/api/event-types/_get.ts @@ -33,7 +33,7 @@ import getCalLink from "./_utils/getCalLink"; * tags: * - event-types * externalDocs: - * url: https://docs.cal.com/core-features/event-types + * url: https://docs.cal.com/docs/core-features/event-types * responses: * 200: * description: OK diff --git a/apps/api/v1/pages/api/event-types/_post.ts b/apps/api/v1/pages/api/event-types/_post.ts index 3d4a2e29bb..4873c1432d 100644 --- a/apps/api/v1/pages/api/event-types/_post.ts +++ b/apps/api/v1/pages/api/event-types/_post.ts @@ -255,7 +255,7 @@ import ensureOnlyMembersAsHosts from "./_utils/ensureOnlyMembersAsHosts"; * tags: * - event-types * externalDocs: - * url: https://docs.cal.com/core-features/event-types + * url: https://docs.cal.com/docs/core-features/event-types * responses: * 201: * description: OK, event type created diff --git a/apps/api/v1/pages/api/teams/[teamId]/event-types/_get.ts b/apps/api/v1/pages/api/teams/[teamId]/event-types/_get.ts index bd17989b19..01ec13cc8b 100644 --- a/apps/api/v1/pages/api/teams/[teamId]/event-types/_get.ts +++ b/apps/api/v1/pages/api/teams/[teamId]/event-types/_get.ts @@ -32,7 +32,7 @@ const querySchema = z.object({ * tags: * - event-types * externalDocs: - * url: https://docs.cal.com/core-features/event-types + * url: https://docs.cal.com/docs/core-features/event-types * responses: * 200: * description: OK diff --git a/apps/api/v1/pages/api/webhooks/[id]/_delete.ts b/apps/api/v1/pages/api/webhooks/[id]/_delete.ts index 894a1b5e3c..e91bd3b7d9 100644 --- a/apps/api/v1/pages/api/webhooks/[id]/_delete.ts +++ b/apps/api/v1/pages/api/webhooks/[id]/_delete.ts @@ -27,7 +27,7 @@ import { schemaQueryIdAsString } from "~/lib/validations/shared/queryIdString"; * tags: * - webhooks * externalDocs: - * url: https://docs.cal.com/core-features/webhooks + * url: https://docs.cal.com/docs/core-features/webhooks * responses: * 201: * description: OK, hook removed successfully diff --git a/apps/api/v1/pages/api/webhooks/[id]/_get.ts b/apps/api/v1/pages/api/webhooks/[id]/_get.ts index 7c079c2df0..9bfd6a0975 100644 --- a/apps/api/v1/pages/api/webhooks/[id]/_get.ts +++ b/apps/api/v1/pages/api/webhooks/[id]/_get.ts @@ -28,7 +28,7 @@ import { schemaWebhookReadPublic } from "~/lib/validations/webhook"; * tags: * - webhooks * externalDocs: - * url: https://docs.cal.com/core-features/webhooks + * url: https://docs.cal.com/docs/core-features/webhooks * responses: * 200: * description: OK diff --git a/apps/api/v1/pages/api/webhooks/[id]/_patch.ts b/apps/api/v1/pages/api/webhooks/[id]/_patch.ts index 7d749b4a61..a35e83b7d2 100644 --- a/apps/api/v1/pages/api/webhooks/[id]/_patch.ts +++ b/apps/api/v1/pages/api/webhooks/[id]/_patch.ts @@ -58,7 +58,7 @@ import { schemaWebhookEditBodyParams, schemaWebhookReadPublic } from "~/lib/vali * tags: * - webhooks * externalDocs: - * url: https://docs.cal.com/core-features/webhooks + * url: https://docs.cal.com/docs/core-features/webhooks * responses: * 201: * description: OK, webhook edited successfully diff --git a/apps/api/v1/pages/api/webhooks/_get.ts b/apps/api/v1/pages/api/webhooks/_get.ts index 1d1e5b02dc..437d70e98e 100644 --- a/apps/api/v1/pages/api/webhooks/_get.ts +++ b/apps/api/v1/pages/api/webhooks/_get.ts @@ -24,7 +24,7 @@ import { schemaWebhookReadPublic } from "~/lib/validations/webhook"; * tags: * - webhooks * externalDocs: - * url: https://docs.cal.com/core-features/webhooks + * url: https://docs.cal.com/docs/core-features/webhooks * responses: * 200: * description: OK diff --git a/apps/api/v1/pages/api/webhooks/_post.ts b/apps/api/v1/pages/api/webhooks/_post.ts index 29a78cf580..7e752004f2 100644 --- a/apps/api/v1/pages/api/webhooks/_post.ts +++ b/apps/api/v1/pages/api/webhooks/_post.ts @@ -56,7 +56,7 @@ import { schemaWebhookCreateBodyParams, schemaWebhookReadPublic } from "~/lib/va * tags: * - webhooks * externalDocs: - * url: https://docs.cal.com/core-features/webhooks + * url: https://docs.cal.com/docs/core-features/webhooks * responses: * 201: * description: OK, webhook created