Add Table of Contents to API Docs (#5138)

emilyrohrbough · web-flow · commit 263f0810a13c · 2023-03-30T15:54:20.000-05:00
diff --git a/docs/api/actions/_category_.json b/docs/api/actions/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Actions",
-  "position": 20
+  "position": 40
 }
diff --git a/docs/api/actions/scrollintoview.mdx b/docs/api/actions/scrollintoview.mdx
@@ -1,5 +1,6 @@
 ---
 title: scrollIntoView
+slug: /api/commands/scrollIntoView
 ---
 
 Scroll an element into view.
diff --git a/docs/api/actions/scrollto.mdx b/docs/api/actions/scrollto.mdx
@@ -1,5 +1,6 @@
 ---
 title: scrollTo
+slug: /api/commands/scrollTo
 ---
 
 Scroll to a specific position.
diff --git a/docs/api/assertions/_category_.json b/docs/api/assertions/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Assertions",
-  "position": 10
+  "position": 30
 }
diff --git a/docs/api/commands/_category_.json b/docs/api/commands/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Other Commands",
-  "position": 40
+  "position": 50
 }
diff --git a/docs/api/commands/debug.mdx b/docs/api/commands/debug.mdx
diff --git a/docs/api/cypress-api/_category_.json b/docs/api/cypress-api/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Cypress API",
-  "position": 70
+  "position": 60
 }
diff --git a/docs/api/cypress-api/catalog-of-events.mdx b/docs/api/cypress-api/catalog-of-events.mdx
@@ -1,5 +1,6 @@
 ---
 title: Catalog of Events
+sidebar_position: 10
 ---
 
 Cypress emits a series of events as it runs in your browser.
diff --git a/docs/api/cypress-api/custom-commands.mdx b/docs/api/cypress-api/custom-commands.mdx
@@ -1,5 +1,6 @@
 ---
 title: Custom Commands
+sidebar_position: 20
 ---
 
 Cypress comes with its own API for creating custom commands and overwriting
diff --git a/docs/api/cypress-api/custom-queries.mdx b/docs/api/cypress-api/custom-queries.mdx
@@ -1,5 +1,6 @@
 ---
 title: Custom Queries
+sidebar_position: 30
 ---
 
 Starting in Cypress 12, Cypress comes with its own API for creating custom
diff --git a/docs/api/events/_category_.json b/docs/api/events/_category_.json
diff --git a/docs/api/queries/_category_.json b/docs/api/queries/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Queries",
-  "position": 30
+  "position": 20
 }
diff --git a/docs/api/queries/retriability-guide.mdx b/docs/api/queries/retriability-guide.mdx
diff --git a/docs/api/table-of-contents.mdx b/docs/api/table-of-contents.mdx
diff --git a/docs/api/utilities/_category_.json b/docs/api/utilities/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Utilities",
-  "position": 60
+  "position": 70
 }
diff --git a/docs/faq/questions/using-cypress-faq.mdx b/docs/faq/questions/using-cypress-faq.mdx
@@ -411,7 +411,7 @@ to either:
 - Prevent Cypress from failing the test
 
 This is documented in detail on the
-[Catalog Of Events](/api/events/catalog-of-events) page and the recipe
+[Catalog Of Events](/api/cypress-api/catalog-of-events) page and the recipe
 [Handling errors](/examples/recipes#Fundamentals).
 
 ## <Icon name="angle-right" /> Will Cypress fail the test when an application has unhandled rejected promise?
diff --git a/docs/guides/core-concepts/interacting-with-elements.mdx b/docs/guides/core-concepts/interacting-with-elements.mdx
@@ -264,9 +264,9 @@ command directly BEFORE the action.
 Make sure your Developer Tools are open and you can get pretty close to "seeing"
 the calculations Cypress is performing.
 
-You can also [bind to Events](/api/events/catalog-of-events) that Cypress fires
-as it's working with your element. Using a debugger with these events will give
-you a much lower level view into how Cypress works.
+You can also [bind to Events](/api/cypress-api/catalog-of-events) that Cypress
+fires as it's working with your element. Using a debugger with these events will
+give you a much lower level view into how Cypress works.
 
 ```js
 // break on a debugger before the action command
diff --git a/docs/guides/guides/debugging.mdx b/docs/guides/guides/debugging.mdx
@@ -246,7 +246,7 @@ by [Cypress Ambassador](https://www.cypress.io/ambassadors/) Josh Justice.
 ## Log Cypress events
 
 Cypress emits multiple events you can listen to as shown below.
-[Read more about logging events in the browser here](/api/events/catalog-of-events#Logging-All-Events).
+[Read more about logging events in the browser here](/api/cypress-api/catalog-of-events#Logging-All-Events).
 
 <DocsImage
   src="/img/api/catalog-of-events/console-log-events-debug.png"
diff --git a/docs/guides/references/changelog.mdx b/docs/guides/references/changelog.mdx
@@ -259,7 +259,7 @@ _Released 02/2/2023_
 
 - Fixed a regression introduced in Cypress [12.5.0](#12-5-0) where the
   `runnable` was not included in the
-  [`test:after:run`](/api/events/catalog-of-events) event. Fixes
+  [`test:after:run`](/api/cypress-api/catalog-of-events) event. Fixes
   [#25663](https://github.com/cypress-io/cypress/issues/25663).
 
 **Dependency Updates:**
@@ -5638,7 +5638,7 @@ _Released 6/8/2020_
 - utf-8 characters now properly display within error code frames. Fixes
   [#7507](https://github.com/cypress-io/cypress/issues/7507).
 - Errors thrown in a
-  [`cy.on('fail', fn)`](/api/events/catalog-of-events#Cypress-Events) fail
+  [`cy.on('fail', fn)`](/api/cypress-api/catalog-of-events#Cypress-Events) fail
   handler now display a stack trace and code frame pointing to the origin of the
   error. Fixes [#7512](https://github.com/cypress-io/cypress/issues/7512).
 - [.click()](/api/commands/click) now properly clicks on wrapped inline elements
@@ -6584,7 +6584,8 @@ _Released 01/10/2020_
   [#5625](https://github.com/cypress-io/cypress/issues/5625).
 - We now capture GitLab CI's `CI_JOB_NAME` environment variable. Addressed in
   [#6111](https://github.com/cypress-io/cypress/pull/6111).
-- Types for [event emitters](/api/events/catalog-of-events#Binding-to-Events)
+- Types for
+  [event emitters](/api/cypress-api/catalog-of-events#Binding-to-Events)
   `removeListener` and `removeAllListeners` have been added to `Cypress` and
   `cy`. Addresses [#5228](https://github.com/cypress-io/cypress/issues/5228).
 - Types for the `runUrl` property returned from `cypress.run()` has been added.
@@ -6941,7 +6942,7 @@ _Released 10/31/2019_
   [#5431](https://github.com/cypress-io/cypress/issues/5431).
 - We fixed a bug where certain types of uncaught errors originating from the
   application under test would not route through the
-  [uncaught:exception](/api/events/catalog-of-events#Uncaught-Exceptions)
+  [uncaught:exception](/api/cypress-api/catalog-of-events#Uncaught-Exceptions)
   handler, and thus could not caught and ignored. These errors will also now
   correctly indicate that they came from application code. Fixes
   [#987](https://github.com/cypress-io/cypress/issues/987).
@@ -10070,7 +10071,7 @@ _Released 10/13/2017_
 
 **Documentation Changes:**
 
-- [Added examples for "Catalog of Events"](/api/events/catalog-of-events)
+- [Added examples for "Catalog of Events"](/api/cypress-api/catalog-of-events)
 - [Added](/ Updated FAQ for "Using Cypress"' using-cypress-faq)
 
 ## 1.0.1
@@ -10394,8 +10395,8 @@ _Released 09/10/2017_
 - We removed an artificial delay that was being set in between commands. This
   means test commands now run faster.
 - You can now
-  [disable Cypress global exception handlers](/api/events/catalog-of-events) for
-  your application. Fixes
+  [disable Cypress global exception handlers](/api/cypress-api/catalog-of-events)
+  for your application. Fixes
   [#254](https://github.com/cypress-io/cypress/issues/254)
 - Uncaught errors appearing in your spec files or support files are now properly
   caught, have the right exit code, and display correctly. Fixes
@@ -10420,10 +10421,11 @@ _Released 09/10/2017_
   automatic screenshot errors.
 - Using mocha's async `done` callback now works properly.
 - You can now programmatically
-  [intercept and potentially turn off uncaught application errors](/api/events/catalog-of-events)
+  [intercept and potentially turn off uncaught application errors](/api/cypress-api/catalog-of-events)
   from failing your tests.
 - You can now programmatically control whether you accept or cancel
-  [window.confirm()](/api/events/catalog-of-events) calls from your application.
+  [window.confirm()](/api/cypress-api/catalog-of-events) calls from your
+  application.
 
 **Dependencies:**
 
@@ -10626,7 +10628,7 @@ _Released 09/10/2017_
 
 Note: we are still updating all of the docs to reflect all the 0.20.0 changes.
 
-- [New "Catalog of Events"](/api/events/catalog-of-events)
+- [New "Catalog of Events"](/api/cypress-api/catalog-of-events)
 - [New "Cypress.Commands"](/api/cypress-api/custom-commands)
 - [New "Cypress.log"](/api/cypress-api/cypress-log)
 - [New ".trigger()"](/api/commands/trigger)
diff --git a/docs/guides/references/error-messages.mdx b/docs/guides/references/error-messages.mdx
@@ -1046,7 +1046,7 @@ currently running test.
 
 You can turn off this behavior globally or conditionally with the
 `uncaught:exception` event. Please see the
-[Catalog of Events](/api/events/catalog-of-events#Uncaught-Exceptions) for
+[Catalog of Events](/api/cypress-api/catalog-of-events#Uncaught-Exceptions) for
 examples.
 
 On a technical note, Cypress considers uncaught exceptions to be any error that
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -87,7 +87,7 @@ const config = {
             activeBasePath: 'guides',
           },
           {
-            to: '/api/commands/and',
+            to: '/api/table-of-contents',
             label: 'API',
             position: 'left',
             activeBasePath: 'api',
diff --git a/netlify.toml b/netlify.toml
@@ -12,20 +12,20 @@
   force = true
 
 [[redirects]]
-  from = "/api/table-of-contents/"
-  to = "/api/commands/and"
+  from = "/api/"
+  to = "/api/table-of-contents/"
   status = 301
   force = true
 
 [[redirects]]
-  from = "/api/"
-  to = "/api/commands/and"
+  from = "/api/api/table-of-contents"
+  to = "/api/table-of-contents/"
   status = 301
   force = true
 
 [[redirects]]
-  from = "/api/api/table-of-contents"
-  to = "/api/table-of-contents/"
+  from = "/api/events/catalog-of-events"
+  to = "/api/cypress-api/catalog-of-events"
   status = 301
   force = true
 
diff --git a/package.json b/package.json
@@ -18,7 +18,7 @@
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
     "preserve": "npm run build:plugins",
-    "serve": "docusaurus serve",
+    "serve": "docusaurus serve --dir dist",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
     "typecheck": "tsc",
diff --git a/src/theme/NotFound/index.tsx b/src/theme/NotFound/index.tsx
@@ -37,7 +37,7 @@ export default function NotFound() {
                       <a href="/guides/core-concepts/introduction-to-cypress">Introduction to Cypress</a>
                     </li>
                     <li>
-                      <a href="/api/commands/and">The API Docs</a>
+                      <a href="/api">The API Docs</a>
                     </li>
                     <li>
                       <a href="/examples/tutorials">Tutorials</a>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Actions",`
`3`		`- "position": 20`
	`3`	`+ "position": 40`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Assertions",`
`3`		`- "position": 10`
	`3`	`+ "position": 30`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Other Commands",`
`3`		`- "position": 40`
	`3`	`+ "position": 50`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Cypress API",`
`3`		`- "position": 70`
	`3`	`+ "position": 60`
`4`	`4`	`}`