Skip to content

Commit

Permalink
Replace API FAQ with design goals section (#20)
Browse files Browse the repository at this point in the history
* Replace API FAQ with design goals section

* Remove extra words
  • Loading branch information
sealer3 authored Sep 26, 2024
1 parent 2bba73f commit 2f399ad
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 27 deletions.
1 change: 0 additions & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
- [Sourcify](./config/options/sourcify.md)
- [User guide]()
- [API Spec](./api-docs/README.md)
- [FAQ](./api-docs/faq.md)
- [ots namespace spec](./api-docs/ots-api.md)
- [ots2 EXPERIMENTAL namespace spec](./api-docs/ots2-api.md)
- [Contract verification](./contract-verification/README.md)
Expand Down
8 changes: 5 additions & 3 deletions src/api-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

> This chapter only makes sense if you intend to dive deep into Otterscan source code or want to integrate directly with the Otterscan APIs.
First, some context about why we chose the approach of implementing a custom API directly inside Ethereum clients.

- [FAQ](./faq.md)
## Specification

There is an ongoing effort to formalize the Otterscan API spec in the same format as the standard JSON-RPC APIs.

Expand All @@ -18,3 +16,7 @@ A more detailed explanation of the `ots` namespace:
There is an experimental `ots2` namespace, which is likely to change, but here is an overview:

- [ots2 namespace spec](./ots2-api.md)

## Design Goals

Otterscan's RPC namespaces aim to provide a minimalistic solution for Ethereum data access which overcomes the limitations of the standard JSON-RPC API. Implementing features directly in-node eliminates the need for additional indexer middleware, databases, or dependencies. Our design prioritizes simplicity and flexibility over high-performance scalability.
23 changes: 0 additions & 23 deletions src/api-docs/faq.md

This file was deleted.

0 comments on commit 2f399ad

Please sign in to comment.