Skip to content

Commit

Permalink
Add documenation section to the README
Browse files Browse the repository at this point in the history
To make our API documentation easier to find an use, this commit adds a
section to the readme describing how to do these things.
  • Loading branch information
Liam Lloyd committed Nov 1, 2024
1 parent d264593 commit b31dd8f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@

# Stela: A Monolithic Typescript Backend for Permanent.org

## Documentation

Historically, documentation of this repo's API server was kept in https://github.com/PermanentOrg/stela/blob/main/API.md.
We are now adopting the OpenAPI specification format for API documentation; new endpoints are documented in this fashion.
To generate an HTML copy of the OpenAPI documentation, run

```bash
redocly build-docs packages/api/docs/present/api.yaml
```

Then open redoc-static.html to view the docs in browser.

## Setup

1. Create a `.env` file
Expand Down

0 comments on commit b31dd8f

Please sign in to comment.