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

Update documentation #190

Merged
merged 3 commits into from
Jan 23, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update documentation
Updated misleading and broken links in the documentation
  • Loading branch information
richardgreg committed Nov 19, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit bda6b48c8f5dc28dd0723e3993a3c614fe0c690b
2 changes: 1 addition & 1 deletion docs/architecture/api.markdown
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ permalink: /api

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.

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/).
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).

### Configuration

2 changes: 1 addition & 1 deletion docs/index.markdown
Original file line number Diff line number Diff line change
@@ -21,4 +21,4 @@ The Pessimism documentation is hosted on Github Pages. To view the documentation

## Contributing

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.
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.
2 changes: 1 addition & 1 deletion docs/openapi/swagger.yml
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ info:
version: 0.0.1
externalDocs:
description: Find out more about Pessimism's architecture
url: 'https://github.com/base-org/pessimism/blob/master/docs/architecture.markdown'
url: 'https://github.com/base-org/pessimism/blob/master/docs/architecture/architecture.markdown'
tags:
- name: heuristic
description: 'Heuristic endpoints'
Loading