docs: add links from reference docs back to build docs (#715)

Co-authored-by: David Moore <[email protected]>
Co-authored-by: Rak Siva <[email protected]>

Author: 3 people

cypress.config.ts

@@ -17,5 +17,6 @@ export default defineConfig({
         },
       })
     },
+    experimentalMemoryManagement: true,
   },
 })

cypress/e2e/broken-links.cy.ts

@@ -33,6 +33,14 @@ const IGNORED_URLS = [
   'https://portal.azure.com',
 ]
 
+const rootBaseUrl = Cypress.config('baseUrl')
+
+const isInternalUrl = (url: string) => {
+  // check against the base url
+  // and check if the url does not contain a file extension
+  return url.startsWith(rootBaseUrl) && !url.includes('.')
+}
+
 const isExternalUrl = (url: string) => {
   return !url.includes('localhost')
 }
@@ -69,14 +77,11 @@ describe('Broken links test suite', () => {
 
       links
         .filter((_i, link) => {
+          const href = link.getAttribute('href')
+          const src = link.getAttribute('src')
+
           return !IGNORED_URLS.some(
-            (l) =>
-              //@ts-ignore
-              (link.getAttribute('href') &&
-                link.getAttribute('href')?.includes(l)) ||
-              //@ts-ignore
-              (link.getAttribute('src') &&
-                link.getAttribute('src').includes(l)),
+            (l) => href?.includes(l) || src?.includes(l),
           )
         })
         .each((link) => {
@@ -89,6 +94,25 @@ describe('Broken links test suite', () => {
             cy.log(`link already checked`)
             expect(VISITED_SUCCESSFUL_LINKS[url]).to.be.true
           } else {
+            // if the link is internal then check the link against the pages fixture (sitemap)
+            if (isInternalUrl(url)) {
+              // clean the url by removing the base url and query params
+              const rootBaseUrlRegex = new RegExp(`^${rootBaseUrl}`)
+              let cleanUrl = url.replace(rootBaseUrlRegex, '')
+              const queryIndex = cleanUrl.indexOf('?')
+              cleanUrl =
+                queryIndex !== -1 ? cleanUrl.slice(0, queryIndex) : cleanUrl
+
+              cy.log(`checking internal link: ${cleanUrl}`)
+              if (!pages.includes(cleanUrl)) {
+                assert.fail(`${cleanUrl} is not part of the pages fixture`)
+              } else {
+                VISITED_SUCCESSFUL_LINKS[url] = true
+              }
+
+              return
+            }
+
             cy.wait(25)
 
             req(url).then((res: Cypress.Response<any>) => {

docs/reference/dart/api/api-all.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a single handler fo
 
 # Dart - api.all()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on a route.
 
 <Note>

docs/reference/dart/api/api-delete.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se
 
 # Dart - api.delete()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register an API route and set a specific HTTP DELETE handler on that route.
 
 <Note>

docs/reference/dart/api/api-get.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se
 
 # Dart - api.get()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register an API route and set a specific HTTP GET handler on that route.
 
 <Note>

docs/reference/dart/api/api-patch.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se
 
 # Dart - api.patch()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register an API route and set a specific HTTP PATCH handler on that route.
 
 <Note>

docs/reference/dart/api/api-post.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se
 
 # Dart - api.post()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register an API route and set a specific HTTP POST handler on that route.
 
 <Note>

docs/reference/dart/api/api-put.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register an API route and se
 
 # Dart - api.put()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register an API route and set a specific HTTP PUT handler on that route.
 
 <Note>

docs/reference/dart/api/api-route-all.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a single handler fo
 
 # Dart - api.route.all()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register a single handler for all HTTP Methods (GET, POST, PUT, DELETE, PATCH) on the route.
 
 ```dart

docs/reference/dart/api/api-route-delete.mdx

@@ -4,6 +4,11 @@ description: "Reference for Nitric's Dart library - Register a handler for HTTP
 
 # Dart - api.route.delete()
 
+<Note>
+  This is reference documentation for the Nitric Dart SDK. To learn about APIs
+  in Nitric start with the [API docs](/apis).
+</Note>
+
 Register a handler for HTTP DELETE requests to the route.
 
 ```dart