fix(platform): correct docs links

perfsee · Sep 26, 2022 · 9271f19 · 9271f19
1 parent 4ad1a03
commit 9271f19
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 6 deletions.
diff --git a/packages/platform/src/modules/access-token/index.tsx b/packages/platform/src/modules/access-token/index.tsx
@@ -29,6 +29,7 @@ import dayjs from 'dayjs'
 import { useCallback, useEffect, useRef } from 'react'
 
 import { ForeignLink, useToggleState } from '@perfsee/components'
+import { staticPath } from '@perfsee/shared/routes'
 
 import { AccessTokenModule } from './access-token.module'
 import { GenerateToken } from './generate-token'
@@ -82,7 +83,7 @@ export const AccessToken = () => {
             />
           </div>
           <Text variant="small">
-            Check out <ForeignLink href="https://perfsee.com/docs/api">Perfsee API</ForeignLink> docs.
+            Check out <ForeignLink href={staticPath.docs.api}>Perfsee API</ForeignLink> docs.
           </Text>
         </Stack>
         <ListWrap>

diff --git a/packages/platform/src/modules/home/components/banner/index.tsx b/packages/platform/src/modules/home/components/banner/index.tsx
@@ -27,7 +27,7 @@ export const HomeBanner = () => {
           <Link to={staticPath.projects}>
             <PrimaryButton>Try now</PrimaryButton>
           </Link>
-          <ForeignLink href="/docs">
+          <ForeignLink href={staticPath.docs.home}>
             <DefaultButton>Docs</DefaultButton>
           </ForeignLink>
         </ButtonsWrap>

diff --git a/packages/platform/src/modules/home/components/layout/header.tsx b/packages/platform/src/modules/home/components/layout/header.tsx
@@ -65,7 +65,7 @@ export const Header = () => {
             <Link to={staticPath.projects}>
               <MediumPrimaryButton>Try now</MediumPrimaryButton>
             </Link>
-            <ForeignLink href="/docs">
+            <ForeignLink href={staticPath.docs.home}>
               <MediumDefaultButton>Docs</MediumDefaultButton>
             </ForeignLink>
           </ButtonsWrap>

diff --git a/packages/platform/src/modules/layout/footer.tsx b/packages/platform/src/modules/layout/footer.tsx
@@ -53,9 +53,9 @@ export const Footer: FC<Props> = memo(({ isAdmin }) => {
       <Container>
         <Line />
         <Links>
-          <FooterForeignLink href="/docs">Documents</FooterForeignLink>
+          <FooterForeignLink href={staticPath.docs.home}>Documents</FooterForeignLink>
           <wbr />
-          <FooterForeignLink href="/docs/api">API</FooterForeignLink>
+          <FooterForeignLink href={staticPath.docs.api}>API</FooterForeignLink>
           <wbr />
           <FooterLink to={staticPath.status}>Status</FooterLink>
           <wbr />

diff --git a/packages/platform/src/modules/layout/operations.tsx b/packages/platform/src/modules/layout/operations.tsx
@@ -37,7 +37,7 @@ export const Operations = () => {
     () => (
       <>
         <Link to={staticPath.accessToken}>API</Link>
-        <ForeignLink href={`${staticPath.home}/docs`}>Docs</ForeignLink>
+        <ForeignLink href={staticPath.docs.home}>Docs</ForeignLink>
         {loggedIn && <a href={SERVER + `/auth/logout`}>Logout</a>}
       </>
     ),

diff --git a/packages/shared/src/routes/router.ts b/packages/shared/src/routes/router.ts
@@ -14,6 +14,7 @@ function makePathsFrom<Params = void>(path: string) {
 
 export interface RouteTypes {
   home: void
+  docs: { home: void; api: void }
   features: { home: void; bundle: void; lab: void; source: void }
   projects: void
   notFound: void
@@ -45,6 +46,7 @@ export interface RouteTypes {
 
 export const staticPath = {
   home: '/',
+  docs: { home: '/docs', api: '/docs/api' },
   features: { home: '/features', bundle: '/features/bundle', lab: '/features/lab', source: '/features/source' },
   projects: '/projects',
   notFound: '/404',
@@ -80,6 +82,10 @@ export const staticPath = {
 
 export const pathFactory = {
   home: makePathsFrom<FactoryParams<RouteTypes['home']>>('/'),
+  docs: {
+    home: makePathsFrom<FactoryParams<RouteTypes['docs']['home']>>('/docs'),
+    api: makePathsFrom<FactoryParams<RouteTypes['docs']['api']>>('/docs/api'),
+  },
   features: {
     home: makePathsFrom<FactoryParams<RouteTypes['features']['home']>>('/features'),
     bundle: makePathsFrom<FactoryParams<RouteTypes['features']['bundle']>>('/features/bundle'),

diff --git a/packages/shared/src/routes/router.yaml b/packages/shared/src/routes/router.yaml
@@ -1,5 +1,9 @@
 base: /
 paths:
+  docs:
+    base: /docs
+    paths:
+      api: /api
   features:
     base: /features
     paths: