Skip to content
This repository was archived by the owner on May 29, 2024. It is now read-only.

Commit d2bcad1

Browse files
richardgregadrain-cb
andauthoredJan 23, 2024··
Update documentation (#190)
Co-authored-by: Adrian Smith <adrian.smith@coinbase.com>
1 parent 7b78b7a commit d2bcad1

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed
 

‎docs/architecture/api.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ permalink: /api
88

99
The Pessimism API is a RESTful HTTP API that allows users to interact with the Pessimism application. The API is built using the [go-chi](https://github.com/go-chi/chi) framework and is served using the native [http package](https://pkg.go.dev/net/http). The API is designed to be modular and extensible, allowing for the addition of new endpoints and functionality with relative ease.
1010

11-
Currently, interactive endpoint documentation is hosted via [Swagger UI](https://swagger.io/tools/swagger-ui/) at [https://base-org.github.io/pessimism/](https://base-org.github.io/pessimism/).
11+
Currently, interactive endpoint documentation is hosted via [Swagger UI](https://swagger.io/tools/swagger-ui/) at [https://base-org.github.io/pessimism/api-doc](https://base-org.github.io/pessimism/api-doc).
1212

1313
### Configuration
1414

‎docs/index.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ The Pessimism documentation is hosted on Github Pages. To view the documentation
2121

2222
## Contributing
2323

24-
If you would like to contribute to the Pessimism documentation, please advise the guidelines stipulated in the [CONTRIBUTING.md](../CONTRIBUTING.md) file __before__ submitting a pull request.
24+
If you would like to contribute to the Pessimism documentation, please advise the guidelines stipulated in the [CONTRIBUTING.md](https://github.com/base-org/pessimism/blob/master/CONTRIBUTING.md) file __before__ submitting a pull request.

‎docs/openapi/swagger.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ info:
1111
version: 0.0.1
1212
externalDocs:
1313
description: Find out more about Pessimism's architecture
14-
url: 'https://github.com/base-org/pessimism/blob/master/docs/architecture.markdown'
14+
url: 'https://github.com/base-org/pessimism/blob/master/docs/architecture/architecture.markdown'
1515
tags:
1616
- name: heuristic
1717
description: 'Heuristic endpoints'

0 commit comments

Comments
 (0)
This repository has been archived.