Skip to content

Commit

Permalink
docs: Fix broken links
Browse files Browse the repository at this point in the history
Refs #70
  • Loading branch information
ingeridhellen committed Sep 20, 2022
1 parent 1626088 commit 6b18ff5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion documentation/docs/how-to/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This whole process is documented nicely on their [website](https://cli.doctave.c

## Publishing

We are using the Github Action [`generate-docs.yaml`](../.github/workflows/generate-docs.yaml) to build and publish the documentation website.
We are using the Github Action [`generate-docs.yaml`](https://github.com/equinor/template-fastapi-react/blob/main/.github/workflows/publish-docs.yaml) to build and publish the documentation website.

This will checkout the code, install Doctave on the build agent, and build the documentation. Then it will deploy the documentation (placed in the site folder) to GitHub Pages.

Expand Down
6 changes: 5 additions & 1 deletion documentation/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ async function createConfig() {
return {
title: 'Template FastAPI React',
tagline: 'Documentation for the FastAPI React Template',
url: 'https://github.com/equinor/template-fastapi-react',
url: 'https://template-fastapi-react.app.radix.equinor.com/',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
Expand Down Expand Up @@ -99,6 +99,10 @@ async function createConfig() {
label: 'GitHub',
href: 'https://github.com/equinor/template-fastapi-react',
},
{
label: 'Template FastAPI React',
href: 'https://template-fastapi-react.app.radix.equinor.com/',
},
],
},
],
Expand Down

0 comments on commit 6b18ff5

Please sign in to comment.