You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
REST API to access [D&D 5th Edition SRD API](https://www.dnd5eapi.co/)
10
9
@@ -24,9 +23,9 @@ Then run it with docker-compose:
24
23
docker compose up --build
25
24
```
26
25
27
-
### M1/M2 Macs
26
+
### M1/M2/M3 Macs
28
27
29
-
The command above pulls the latest image of the database from ghcr.io, which only targets the amd64 platform. If you are running on a different platform (like an M1/M2 mac), you will need to build the image yourself. See the [5e-database](https://github.com/5e-bits/5e-database#how-to-run) repo for additional details.
28
+
The command above pulls the latest image of the database from ghcr.io, which only targets the amd64 platform. If you are running on a different platform (like a Mac with Apple Silicon), you will need to build the image yourself. See the [5e-database](https://github.com/5e-bits/5e-database#how-to-run) repo for additional details.
30
29
31
30
```shell
32
31
cd ../
@@ -99,7 +98,7 @@ contents.
99
98
100
99
## Data Issues
101
100
102
-
If you see anything wrong with the data itself, please open an issue or PR over [here.](https://github.com/bagelbits/5e-database)
101
+
If you see anything wrong with the data itself, please open an issue or PR over [here.](https://github.com/5e-bits/5e-database/)
103
102
104
103
## Running Tests
105
104
@@ -116,9 +115,10 @@ In order to run integration tests locally you can use the command: `npm run test
116
115
117
116
Public facing API documentation lives [here.](https://www.dnd5eapi.co/docs)
118
117
119
-
We use [RapiDoc](https://mrin9.github.io/RapiDoc/index.html) to create the documentation UI from a bundled single file OpenAPI definition created as part of the `npm run build` task.
118
+
The [docs repository](https://github.com/5e-bits/docs) contains the source for the public facing API documentation. It uses
119
+
[Docusaurus](https://docusaurus.io/) to generate the site from a bundled OpenAPI spec.
120
120
121
-
Additional details and information on working with the documentation can be found in the `/swagger` directory's [README](src/swagger/README.md).
121
+
More details on working with the OpenAPI spec can be found in the [`src/swagger`](src/swagger/) directory's [README](src/swagger/README.md).
0 commit comments