Skip to content

Commit 7ef2453

Browse files
Clean up docs page (#13854)
1 parent c2fb634 commit 7ef2453

3 files changed

Lines changed: 86 additions & 2948 deletions

File tree

docs/.vscode/settings.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
{
22
"editor.rulers": [100],
3-
"workbench.colorCustomizations": {
4-
"titleBar.activeBackground": "#7E1BCC",
5-
"titleBar.activeForeground": "#FFF"
6-
},
73
"prettier.proseWrap": "always",
84
"[mdx]": {
95
"editor.formatOnSave": true,

docs/README.md

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,51 @@
11
# docs.audius.co
22

3-
## Dependencies
3+
Audius Developer Docs built with [Vocs](https://vocs.dev).
44

5-
Install dependencies:
5+
## Setup
66

77
```sh
88
npm install
99
```
1010

11-
---
12-
13-
## Development Server
14-
15-
To run the docs locally:
11+
## Development
1612

1713
```sh
1814
npm run dev
1915
```
2016

21-
To develop on Cloudflare pages and test the whole stack:
17+
Runs the Vocs dev server. For Cloudflare Pages testing:
2218

2319
```sh
2420
npm run pages:dev
2521
```
2622

27-
---
28-
29-
## Updating the API Spec
30-
31-
The API reference uses Stoplight Elements and loads the OpenAPI spec from `/openapi.yaml`. To sync the latest spec from the live API:
23+
## Build & Preview
3224

3325
```sh
34-
npm run sync:api-spec
26+
npm run build
27+
npm run preview
3528
```
3629

37-
This script:
38-
39-
- Downloads `https://api.audius.co/v1/swagger.yaml`
40-
- Rewrites any legacy `discoveryprovider.audius.co` hosts to `api.audius.co`
41-
- Saves the patched spec to `docs/public/openapi.yaml`
42-
- Deduplicates server entries
30+
`preview` serves the production build locally.
4331

44-
---
32+
## Deploy
4533

46-
## Build
34+
From the `main` branch:
4735

4836
```sh
49-
npm run build
37+
npm run pages:deploy
5038
```
5139

52-
---
40+
Builds and deploys to Cloudflare Pages. Requires `wrangler login` if not authenticated.
5341

54-
## Publish
42+
## API Spec
5543

56-
To deploy to docs.audius.co, run from the `main` branch:
44+
The API reference loads the OpenAPI spec from `/openapi.yaml`. To sync from the live API:
5745

5846
```sh
59-
npm run build
60-
npm run pages:deploy
47+
npm run sync:api-spec
6148
```
49+
50+
Downloads `https://api.audius.co/v1/swagger.yaml`, patches hosts to `api.audius.co`, deduplicates
51+
servers, and saves to `docs/public/openapi.yaml`.

0 commit comments

Comments
 (0)