Fix internal links with .html in them

pete-woods · pete-woods · commit 0ba13bf42fa3 · 2025-08-07T12:24:26.000+01:00
diff --git a/api-v1/index.html b/api-v1/index.html
@@ -2687,7 +2687,7 @@ <h2 id='trigger-a-new-job'>Trigger a new Job</h2><div class="highlight"><pre cla
 </span><span class="p">}</span><span class="w">
 </span></code></pre></div>
 <aside class="warning">
-We recommend migrating from this endpoint to use API v2  <a href="https://circleci.com/docs/api/v2/index.html#operation/triggerPipeline">trigger a pipeline</a>.
+We recommend migrating from this endpoint to use API v2  <a href="https://circleci.com/docs/api/v2/#operation/triggerPipeline">trigger a pipeline</a>.
 </aside>
 
 <p><strong><code>POST</code> Request:</strong> Triggers a new job and then returns a summary of the job run.</p>
diff --git a/custom-template.hbs b/custom-template.hbs
@@ -74,12 +74,12 @@
 <body>
   <!-- Clickable logo that routes to docs homepage -->
   <div class="custom-logo">
-    <a href="../../reference/api-homepage.html" title="Back to CircleCI Documentation">
+    <a href="../../reference/api-homepage" title="Back to CircleCI Documentation">
       <img src="logo.svg" alt="CircleCI" />
     </a>
   </div>
 
   {{{redocHTML}}}
 </body>
 
-</html>
+</html>
diff --git a/docs/guides/modules/about-circleci/pages/benefits-of-circleci.adoc b/docs/guides/modules/about-circleci/pages/benefits-of-circleci.adoc
@@ -18,7 +18,7 @@ As a developer using CircleCI you can:
 - Access xref:execution-managed:using-arm.adoc[Arm VM resources] and xref:execution-managed:using-docker.adoc#arm[Arm on Docker].
 - Use xref:orbs:use:orb-intro.adoc[orbs], reusable packages of configuration, to integrate with third parties.
 - Use pre-built Docker xref:execution-managed:circleci-images.adoc[images] in a variety of languages.
-- Use the link:https://www.circleci.com/docs/api/v2[API] to retrieve information about jobs and workflows.
+- Use the link:https://www.circleci.com/docs/api/v2/[API] to retrieve information about jobs and workflows.
 - Use the xref:toolkit:local-cli.adoc[CLI] to access advanced tools locally.
 - Get flaky test detection with xref:insights:insights-tests.adoc[test insights].
 
diff --git a/docs/guides/modules/insights/pages/insights-glossary.adoc b/docs/guides/modules/insights/pages/insights-glossary.adoc
@@ -92,16 +92,16 @@ display the change in value or delta compared to the prior 7-day window.
 
 Trends displayed in the CircleCI UI are calculated as `100 * (current value - previous value) / prior-value`.
 
-Trends received from the link:https://circleci.com/docs/api/v2/index.html#operation/getProjectWorkflowsPageData[CircleCI API] are calculated as a ratio instead of a percentage with the following formula: `(current-value / prior-value)`. These trends are 1-based and not 0-based.
+Trends received from the link:https://circleci.com/docs/api/v2/#operation/getProjectWorkflowsPageData[CircleCI API] are calculated as a ratio instead of a percentage with the following formula: `(current-value / prior-value)`. These trends are 1-based and not 0-based.
 
 * A ratio of 1.0 indicates _no change_.
 * A value less than 1.0 indicates a negative trend, and a value greater than 1.0 indicates a positive trend.
 * A value of -1.0 is an infinite trend.
 
 This also applies to the following API endpoints:
 
-* link:https://circleci.com/docs/api/v2/index.html#operation/getOrgSummaryData[getOrgSummaryData]
-* link:https://circleci.com/docs/api/v2/index.html#operation/getWorkflowSummary[getWorkflowSummary].
+* link:https://circleci.com/docs/api/v2/#operation/getOrgSummaryData[getOrgSummaryData]
+* link:https://circleci.com/docs/api/v2/#operation/getWorkflowSummary[getWorkflowSummary].
 
 Despite the trend being reported as a ratio via the API, the result returned is still effectively equivalent to the percentage that is shown in the UI. To compare the ratio from the API with the percentage reported in the UI, you can compute `| trend-value - 1|` (vertical line indicates absolute value). For example, if the API returns a ratio of 3.33, in the UI it will be shown as `| 3.33 - 1 | = 2.33` which is equivalent to +233%.
 
diff --git a/docs/guides/modules/insights/pages/insights.adoc b/docs/guides/modules/insights/pages/insights.adoc
@@ -68,4 +68,4 @@ Select the *Jobs* tab next to *Overview* to view the following cumulative data o
 
 Refer to the xref:test:collect-test-data.adoc[Collect Test Data] document for guidance on configuring Insights into your most failed tests.
 
-See the link:https://circleci.com/docs/api/v2#tag/Insights[Insights API reference].
+See the link:https://circleci.com/docs/api/v2/#tag/Insights[Insights API reference].
diff --git a/docs/guides/modules/integration/pages/version-control-system-integration-overview.adoc b/docs/guides/modules/integration/pages/version-control-system-integration-overview.adoc
@@ -125,7 +125,7 @@ include::ROOT:partial$tips/check-github-type.adoc[Check your GitHub integration
 | [.circle-red]#**No**#
 | [.circle-red]#**No**#
 
-| link:https://circleci.com/docs/api/v2/index.html#operation/triggerPipeline[Trigger pipelines via API]
+| link:https://circleci.com/docs/api/v2/#operation/triggerPipeline[Trigger pipelines via API]
 | [.circle-green]#**Yes**#
 | [.circle-red]#**No**#
 | [.circle-red]#**No**#
diff --git a/docs/guides/modules/optimize/pages/artifacts.adoc b/docs/guides/modules/optimize/pages/artifacts.adoc
@@ -181,7 +181,7 @@ curl --silent --request GET --url https://circleci.com/api/v2/workflow/:workflow
   | wget --verbose --header "Circle-Token: $CIRCLE_TOKEN" --no-verbose --input-file -
 ----
 
-You can read more about using CircleCI's API to interact with artifacts in our link:../../api/v1/index.html#artifacts[API reference guide].
+You can read more about using CircleCI's API to interact with artifacts in our link:../../../api/v1/#artifacts[API reference guide].
 
 [cols="1,2", options="header"]
 |===
diff --git a/docs/guides/modules/optimize/pages/caching.adoc b/docs/guides/modules/optimize/pages/caching.adoc
@@ -455,7 +455,7 @@ If your source code changes frequently, we recommend using fewer, more specific
 
 Even with the narrowest `restore_cache` option (`source-v1-{{ .Branch }}-{{ .Revision }}`), source caching can be greatly beneficial, for example:
 
-* Running repeated builds against the same git revision (for example, with link:../../api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun[API-triggered builds])
+* Running repeated builds against the same git revision (for example, with link:../../../api/v2/#tag/Pipeline/operation/triggerPipelineRun[API-triggered builds])
 * When using workflows, where you might otherwise need to `checkout` the same repository once per workflow job.
 
 However, it is worth comparing build times with and without source caching. `git clone` is often faster than `restore_cache`.
diff --git a/docs/guides/modules/orchestrate/pages/migrate-scheduled-workflows-to-scheduled-pipelines.adoc b/docs/guides/modules/orchestrate/pages/migrate-scheduled-workflows-to-scheduled-pipelines.adoc
@@ -75,7 +75,7 @@ curl --location --request POST "https://circleci.com/api/v2/project/<project-slu
 
 include::ROOT:partial$tips/find-project-slug.adoc[]
 
-For additional information, refer to the **Schedule** section under the link:https://circleci.com/docs/api/v2[API v2 docs]. Also see the xref:toolkit:api-developers-guide.adoc#getting-started-with-the-api[Getting started with the API] section of the API Developer's Guide for more guidance on making requests.
+For additional information, refer to the **Schedule** section under the link:https://circleci.com/docs/api/v2/[API v2 docs]. Also see the xref:toolkit:api-developers-guide.adoc#getting-started-with-the-api[Getting started with the API] section of the API Developer's Guide for more guidance on making requests.
 
 [#use-project-settings]
 === b. Use project settings in the web app
diff --git a/docs/guides/modules/orchestrate/pages/scheduled-pipelines.adoc b/docs/guides/modules/orchestrate/pages/scheduled-pipelines.adoc
@@ -69,7 +69,7 @@ curl --location --request POST "https://circleci.com/api/v2/project/<project-slu
 
 include::ROOT:partial$tips/find-project-slug.adoc[]
 
-For additional information, refer to the **Schedule** section under the link:https://circleci.com/docs/api/v2[API v2 docs]. Also see the xref:toolkit:api-developers-guide.adoc#getting-started-with-the-api[Getting started with the API] section of the API Developer's Guide for more guidance on making requests.
+For additional information, refer to the **Schedule** section under the link:https://circleci.com/docs/api/v2/[API v2 docs]. Also see the xref:toolkit:api-developers-guide.adoc#getting-started-with-the-api[Getting started with the API] section of the API Developer's Guide for more guidance on making requests.
 
 [#migrate-scheduled-workflows-to-scheduled-pipelines]
 == Migrate scheduled workflows to scheduled pipelines
diff --git a/docs/guides/modules/security/pages/contexts.adoc b/docs/guides/modules/security/pages/contexts.adoc
@@ -10,7 +10,7 @@ If you have existing contexts (or environment variables) and you would like to r
 [#overview]
 == Overview
 
-Manage contexts on the *Organization Settings* page of the https://app.circleci.com[CircleCI web app], or via the link:https://circleci.com/docs/api/v2/index.html#tag/Context[API]. You must be an organization member to view, create, or edit contexts.
+Manage contexts on the *Organization Settings* page of the https://app.circleci.com[CircleCI web app], or via the link:https://circleci.com/docs/api/v2/#tag/Context[API]. You must be an organization member to view, create, or edit contexts.
 
 Create a context and then add environment variables to it. You can use the xref:reference:ROOT:configuration-reference.adoc#context[`context` key] in the workflows section of a project's `.circleci/config.yml` file to give any job(s) access to the environment variables associated with the context, as shown in the image below.
 
diff --git a/docs/guides/modules/security/pages/inject-environment-variables-with-api.adoc b/docs/guides/modules/security/pages/inject-environment-variables-with-api.adoc
@@ -11,14 +11,14 @@ include::ROOT:partial$notes/server-api-examples.adoc[]
 Pipeline parameters can be used to pass variables using the CircleCI API v2.
 
 A pipeline can be triggered with specific parameter values using the API v2
-endpoint to link:../../api/v2/index.html#operation/getPipelineConfigById[trigger a pipeline].
+endpoint to link:../../../api/v2/#operation/getPipelineConfigById[trigger a pipeline].
 This can be done by passing a `parameters` key in the JSON packet of the `POST` body.
 
 The example below triggers a pipeline with parameter values for `workingdir` and `image-tag`.
 
 NOTE: In order to pass a parameter when triggering a pipeline via the API, the parameter must be xref:reference:ROOT:reusing-config.adoc#using-the-parameters-declaration[declared in the configuration file].
 
-CAUTION: If your project code is integrated with CircleCI via the GitHub App, GitLab or Bitbucket Data Center, you will need to use the new link:../../api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun[Trigger a new pipeline endpoint] rather than the endpoint used in this example.
+CAUTION: If your project code is integrated with CircleCI via the GitHub App, GitLab or Bitbucket Data Center, you will need to use the new link:../../../api/v2/#tag/Pipeline/operation/triggerPipelineRun[Trigger a new pipeline endpoint] rather than the endpoint used in this example.
 
 ```shell
 curl -u ${CIRCLE_TOKEN}: -X POST --header "Content-Type: application/json" -d '{
@@ -71,7 +71,7 @@ export param1="value1"
 export param2="500"
 ```
 
-A POST API call with an empty body will start a new run of the named branch. Refer to the link:../../api/v1/index.html#trigger-a-new-job-with-a-branch[Trigger a new job with a branch] section of the API v1 documentation for details.
+A POST API call with an empty body will start a new run of the named branch. Refer to the link:../../../api/v1/#trigger-a-new-job-with-a-branch[Trigger a new job with a branch] section of the API v1 documentation for details.
 
 [#best-practices-for-using-build-parameters-with-api-v1]
 === Best practices for using build parameters with API v1
diff --git a/docs/guides/modules/test/pages/collect-test-data.adoc b/docs/guides/modules/test/pages/collect-test-data.adoc
@@ -61,7 +61,7 @@ include::ROOT:partial$notes/standalone-unsupported.adoc[This feature is not supp
 See the xref:insights:insights-tests.adoc[Test Insights] page for information on using the Insights feature to gather information about your tests.
 This includes flaky test detection, viewing tests that failed most often, slowest tests, and an overall performance summary.
 
-Also, see the link:https://circleci.com/docs/api/v2/index.html#tag/Insights[API v2 Insights endpoints] to find test failure information.
+Also, see the link:https://circleci.com/docs/api/v2/#tag/Insights[API v2 Insights endpoints] to find test failure information.
 
 [#enabling-formatters]
 == Enabling formatters
diff --git a/docs/guides/modules/toolkit/pages/api-developers-guide.adoc b/docs/guides/modules/toolkit/pages/api-developers-guide.adoc
@@ -104,7 +104,7 @@ To find your project slug, follow these steps:
 . Select the ellipsis menu image:guides:ROOT:icons/more.svg[more icon, role="no-border"] next to your project and select **Project Settings**.
 . The project slug is listed on the project settings homepage. Use the copy button to copy the slug to your clipboard.
 
-The `project_slug` is also included in the response payload when looking up a link:https://circleci.com/docs/api/v2/index.html#tag/Pipeline/operation/getPipelineById[pipeline] or link:https://circleci.com/docs/api/v2/index.html#tag/Workflow/operation/getWorkflowById[workflow] by ID. The project slug can then be used to get information about the project.
+The `project_slug` is also included in the response payload when looking up a link:https://circleci.com/docs/api/v2/#tag/Pipeline/operation/getPipelineById[pipeline] or link:https://circleci.com/docs/api/v2/#tag/Workflow/operation/getWorkflowById[workflow] by ID. The project slug can then be used to get information about the project.
 
 === GitHub OAuth and Bitbucket Cloud
 If your integrate your code via the GitHub OAuth app or Bitbucket Cloud, your project slug is in a human readable format: `vcs_type/org_name/repo_name` (VCS type can be `github`/`bitbucket` or `gh`/`bb`).
@@ -142,7 +142,7 @@ The following section details the steps you would need, from start to finish, to
 
 Many of the API calls make use of the +++`{project-slug}`+++ triplet, described <<getting-started-with-the-api,above>>.
 
-You will get a list of pipelines for your project using link:https://circleci.com/docs/api/v2/index.html#tag/Pipeline/operation/listPipelinesForProject[+++`GET /project/{project-slug}/pipeline`+++].
+You will get a list of pipelines for your project using link:https://circleci.com/docs/api/v2/#tag/Pipeline/operation/listPipelinesForProject[+++`GET /project/{project-slug}/pipeline`+++].
 
 [#prerequisites]
 === Prerequisites
diff --git a/docs/guides/modules/toolkit/pages/api-intro.adoc b/docs/guides/modules/toolkit/pages/api-intro.adoc
@@ -5,8 +5,8 @@
 
 The CircleCI API may be used to make API calls to interact with your pipelines, projects and orgs, including retrieving detailed information about users, jobs, workflows, and pipelines, as well as triggering pipelines. There are currently two supported API versions:
 
-* link:../../api/v1/index.html[API v1.1 Reference]
-* link:../../api/v2/index.html[API v2 Reference]
+* link:../../../api/v1/[API v1.1 Reference]
+* link:../../../api/v2/[API v2 Reference]
 
 API v2 includes several powerful features (for example, support for pipelines and pipeline parameters) that are unavailable in API v1.1. It is recommended that CircleCI users migrate their scripts to API v2 stable endpoints as soon as possible.
 
@@ -19,7 +19,7 @@ To get started with the API v2, see the xref:api-developers-guide.adoc[API devel
 
 The CircleCI API v2 release includes several new endpoints, and deprecates some others. The sections below list the endpoints added for this release, in addition to the endpoints that have been removed.
 
-For a complete list of all API v2 endpoints, refer to the link:../../api/v2/[API v2 Reference Guide], which contains a detailed description of each individual endpoint, as well as information on required and optional parameters, HTTP status and error codes, and code samples you may use in your workflows.
+For a complete list of all API v2 endpoints, refer to the link:../../../api/v2/[API v2 Reference Guide], which contains a detailed description of each individual endpoint, as well as information on required and optional parameters, HTTP status and error codes, and code samples you may use in your workflows.
 
 [#deprecated-endpoints]
 === Deprecated endpoints
diff --git a/docs/orbs/modules/use/pages/managing-url-orbs-allow-lists.adoc b/docs/orbs/modules/use/pages/managing-url-orbs-allow-lists.adoc
@@ -44,7 +44,7 @@ API::
 include::guides:ROOT:partial$notes/server-api-examples.adoc[]
 
 . Set up your API authentication. Steps are available in the xref:guides:toolkit:api-developers-guide.adoc#add-an-api-token[API developers guide].
-. Send a *POST* request to the link:https://circleci.com/docs/api/v2/index.html#tag/Organization/operation/createURLOrbAllowListEntry[Create a new URL orb allow-list entry] endpoint to add an allow-list entry, with a JSON map containing name, prefix, and auth keys, as the request body.
+. Send a *POST* request to the link:https://circleci.com/docs/api/v2/#tag/Organization/operation/createURLOrbAllowListEntry[Create a new URL orb allow-list entry] endpoint to add an allow-list entry, with a JSON map containing name, prefix, and auth keys, as the request body.
 
 Example:
 
@@ -88,7 +88,7 @@ API::
 include::guides:ROOT:partial$notes/server-api-examples.adoc[]
 
 . Set up your API authentication. Steps are available in the xref:guides:toolkit:api-developers-guide.adoc#add-an-api-token[API developers guide].
-. Send a *GET* request to the link:https://circleci.com/docs/api/v2/index.html#tag/Organization/operation/listURLOrbAllowListEntries[List the entries in the org's URL Orb allow-list] endpoint to view the organization's URL orb allow-lists.
+. Send a *GET* request to the link:https://circleci.com/docs/api/v2/#tag/Organization/operation/listURLOrbAllowListEntries[List the entries in the org's URL Orb allow-list] endpoint to view the organization's URL orb allow-lists.
 
 Example:
 
@@ -136,7 +136,7 @@ API::
 include::guides:ROOT:partial$notes/server-api-examples.adoc[]
 
 . Set up your API authentication. Steps are available in the xref:guides:toolkit:api-developers-guide.adoc#add-an-api-token[API developers guide].
-. Send a *DELETE* request to the link:https://circleci.com/docs/api/v2/index.html#tag/Organization/operation/removeURLOrbAllowListEntry[Remove an entry from the org's URL orb allow-list] endpoint to delete the allow-list entry.
+. Send a *DELETE* request to the link:https://circleci.com/docs/api/v2/#tag/Organization/operation/removeURLOrbAllowListEntry[Remove an entry from the org's URL orb allow-list] endpoint to delete the allow-list entry.
 
 Example:
 
@@ -165,4 +165,4 @@ Example response:
 * A hierarchy of URL orbs may not exceed a depth of 5 orb references.
 * The `GitHub OAuth` and `Bitbucket OAuth` auth types assume that any member of the organization known to CircleCI has permission to fetch the URL orb. If this is not true then seemingly arbitrary failures to fetch URL orbs will occur. The `GitHub App` auth type does not have this limitation.
 * Once an orb has been fetched the content is cached for 5 minutes. This is both to reduce load on the remote system hosting the orb, and to improve build times for busy projects.
-* GitLab authentication is currently not supported.
+* GitLab authentication is currently not supported.
diff --git a/docs/reference/modules/ROOT/pages/api-homepage.adoc b/docs/reference/modules/ROOT/pages/api-homepage.adoc
@@ -3,8 +3,8 @@
 
 Find reference docs for the CircleCI APIs:
 
-* link:../api/v2/index.html[API v2 docs]
-* link:../api/v1/index.html[API v1 docs]
+* link:../../api/v2/[API v2 docs]
+* link:../../api/v1/[API v1 docs]
 
 
 
diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
   "description": "his is the public repository for <https://circleci.com/docs/>, a static website generated with [Antora](https://antora.org/).",
   "scripts": {
     "start:dev": "dotenvx run -- npm run build:ui && gulp preview:docs",
+    "htmlproofer:dev": "htmlproofer ./build --ignore-empty-alt --checks 'Links,Images' --disable-external --swap-urls '^/docs/:/' --ignore-files './build/api/v1/index.html,./build/api/v2/index.html' --ignore-urls '[url],[path]'",
     "preview:ui": "dotenvx run -- gulp preview:ui",
     "build:ui": "gulp build:ui",
     "build:api-docs": "gulp build:api-docs",
diff --git a/ui/src/partials/component-explorer-nav.hbs b/ui/src/partials/component-explorer-nav.hbs
@@ -18,7 +18,7 @@
       <img src="{{{uiRootPath}}}/img/link-arrow.svg" alt="Go to" class="md:hidden ml-2 inline-block w-[13px] h-[13px]">
     </li>
     <li class="flex items-center">
-      <a href="{{{siteRootPath}}}/reference/api-homepage.html" class="inline-block md:px-2 md:py-3">
+      <a href="{{{siteRootPath}}}/reference/api-homepage" class="inline-block md:px-2 md:py-3">
         API
       </a>
       <img src="{{{uiRootPath}}}/img/link-arrow.svg" alt="Go to" class="md:hidden ml-2 inline-block w-[13px] h-[13px]">
diff --git a/ui/src/partials/landing.hbs b/ui/src/partials/landing.hbs

Original file line number	Diff line number	Diff line change
`@@ -68,4 +68,4 @@ Select the Jobs tab next to Overview to view the following cumulative data o`
`68`	`68`
`69`	`69`	`Refer to the xref:test:collect-test-data.adoc[Collect Test Data] document for guidance on configuring Insights into your most failed tests.`
`70`	`70`
`71`		`-See the link:https://circleci.com/docs/api/v2#tag/Insights[Insights API reference].`
	`71`	`+See the link:https://circleci.com/docs/api/v2/#tag/Insights[Insights API reference].`