Update documentation

Updated misleading and broken links in the documentation
base-org · Nov 19, 2023 · bda6b48 · bda6b48
1 parent d1ec230
commit bda6b48
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/architecture/api.markdown b/docs/architecture/api.markdown
@@ -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
 

diff --git a/docs/index.markdown b/docs/index.markdown
@@ -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.
diff --git a/docs/openapi/swagger.yml b/docs/openapi/swagger.yml
@@ -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'
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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.