Skip to content

Commit 5ddf517

Browse files
Replace docusaurus with vocs, clean up (#13845)
https://41adb81c.docs-eaf.pages.dev/
1 parent 9cece7f commit 5ddf517

943 files changed

Lines changed: 11751 additions & 38524 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
merged.txt
22
.wrangler
3-
i18n/
3+
build/

docs/.vscode/spellright.dict

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ cloudflare
66
ddex
77
delegater
88
delegaters
9-
docusaurus
109
erc
1110
ern
1211
ern3

docs/README.md

Lines changed: 10 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Dependencies
44

5-
Install dependencies, run:
5+
Install dependencies:
66

77
```sh
88
npm install
@@ -12,61 +12,34 @@ npm install
1212

1313
## Development Server
1414

15-
To run the docs locally, run:
15+
To run the docs locally:
1616

1717
```sh
18-
npm run start
18+
npm run dev
1919
```
2020

21-
To develop on Cloudflare pages and test the whole stack, run:
21+
To develop on Cloudflare pages and test the whole stack:
2222

2323
```sh
2424
npm run pages:dev
2525
```
2626

2727
---
2828

29-
## Generate REST API docs
29+
## Updating the API Spec
3030

31-
### Configure
32-
33-
Open `docusaurus.config.js` and find the `config:plugins:docusaurus-plugin-openapi-docs:config`
34-
section values.
35-
36-
Edit the commented fields to suit your needs
37-
38-
```js
39-
config: {
40-
api: {
41-
specPath: 'docs/developers/openapi.yaml', // synced from https://api.audius.co/v1/swagger.yaml
42-
outputDir: 'docs/developers/api', // output directory for generated *.mdx and sidebar.js files
43-
sidebarOptions: {
44-
groupPathsBy: 'tag', // generate a sidebar.js slice that groups operations by tag
45-
},
46-
},
47-
},
48-
```
49-
50-
> [!NOTE]
51-
>
52-
> Use `npm run gen:api-docs` (below) to sync the live spec and keep the base URL set to `https://api.audius.co/v1`.
53-
54-
### Updating the Live API Docs
55-
56-
1. From the repo root, run:
31+
The API reference uses Stoplight Elements and loads the OpenAPI spec from `/openapi.yaml`. To sync the latest spec from the live API:
5732

5833
```sh
59-
npm run gen:api-docs
34+
npm run sync:api-spec
6035
```
6136

6237
This script:
6338

6439
- Downloads `https://api.audius.co/v1/swagger.yaml`
6540
- Rewrites any legacy `discoveryprovider.audius.co` hosts to `api.audius.co`
66-
- Saves the patched spec to `docs/developers/openapi.yaml`
67-
- Regenerates every API doc (and `docs/developers/api/sidebar.ts`) from the live spec
68-
69-
> Powered by [docusaurus-plugin-openapi-docs](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs)
41+
- Saves the patched spec to `docs/public/openapi.yaml`
42+
- Deduplicates server entries
7043

7144
---
7245

@@ -80,9 +53,7 @@ npm run build
8053

8154
## Publish
8255

83-
Running the following commands will create a public test site to view your changes.
84-
85-
To deploy to docs.audius.co, ensure the commands are run from the `main` branch.
56+
To deploy to docs.audius.co, run from the `main` branch:
8657

8758
```sh
8859
npm run build

docs/babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/crowdin.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/docs.code-workspace

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)