Skip to content

Commit

Permalink
[DOCS] - repair reference links and set config to throw errors on bre…
Browse files Browse the repository at this point in the history
…aks (#7231)
  • Loading branch information
samgutentag authored Jan 18, 2024
1 parent f6ad76f commit dc4fa10
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/docs/developers/log-in-with-audius.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Be careful to not expose API secrets on your frontend!

- [Read full SDK `oauth` docs](sdk-oauth-methods)

- [Explore the API docs](./sdk/classes/TracksApi)
- [Explore the API docs](./developers/sdk/Tracks)

:::note

Expand Down Expand Up @@ -440,6 +440,6 @@ const track = await audiusSdk.tracks.favoriteTrack({
});
```

See [Getting Started](/developers/sdk) with the SDK or [the SDK methods reference](/developers/sdk/classes/TracksApi) for further reading.
See [Getting Started](/developers/sdk) with the SDK or [the SDK methods reference](/developers/sdk/Tracks) for further reading.

#### [A quick note on email](#retrieving-email-addresses)
2 changes: 1 addition & 1 deletion docs/docs/developers/sdk/Playlists.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ Upload the specified tracks and combine them into a new playlist.

A playlist is a living thing that can change and grow over time. Playlists can contain a user's own tracks, as well as tracks uploaded by others.

See [uploadAlbum](developers/write-albums) to upload an album instead of a playlist.
See [uploadAlbum](/developers/sdk/Albums#uploadAlbum) to upload an album instead of a playlist.

Example:

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/token/running-a-node/setup/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ audius-cli set-config --required discovery-provider

#### Creator Node

There are four required creator node environment variables, available in the creator node section [here](setup.md#creator-node).
There are four required creator node environment variables, available in the creator node section [here](/token/running-a-node/setup/installation#creator-node).

The full list of variables and explanations can be found [here](https://github.com/AudiusProject/audius-protocol/blob/main/creator-node/src/config.js). Generally node operators will not need to modify any other environment variables.

Expand All @@ -40,7 +40,7 @@ value : <db url>

#### Discovery Provider

There are two required discovery provider environment variables, available in the discovery provider section [here](setup.md#discovery-provider).
There are two required discovery provider environment variables, available in the discovery provider section [here](/token/running-a-node/setup/installation#discovery-provider).

The full list of variables and explanations can be found [here](https://github.com/AudiusProject/audius-protocol/blob/main/packages/discovery-provider/default_config.ini). Generally node operators will not need to modify any other environment variables.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/token/running-a-node/setup/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ During installation there will be prompts for required environment variables. Th
- `delegatePrivateKey` - Private key associated with `delegateOwnerWallet`
- `spOwnerWallet` - Wallet that registered (or will register) the content node on chain

If you're using an externally managed Postgres DB please see [this section](advanced_setup.md#external-creator-node-postgres)
If you're using an externally managed Postgres DB please see [this section](/token/running-a-node/setup/advanced#external-discovery-provider-postgres-instance)

## Discovery Provider

- `audius_delegate_owner_wallet` - Address of wallet that contains no tokens but that is registered on chain, used to sign JSON responses from server
- `audius_delegate_private_key` - Private key associated with `audius_delegate_owner_wallet`

If you're using an externally managed Postgres DB please see [this section](advanced_setup.md#external-discovery-provider-postgres-instance)
If you're using an externally managed Postgres DB please see [this section](/token/running-a-node/setup/advanced#external-discovery-provider-postgres-instance)

## More options

Expand Down
4 changes: 2 additions & 2 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula");
tagline: "",
url: "https://docs.audius.org",
baseUrl: "/",
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
organizationName: "AudiusProject", // Usually your GitHub org/user name.
projectName: "docs.audius.org", // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',

presets: [
[
Expand Down

0 comments on commit dc4fa10

Please sign in to comment.