Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
3 changes: 3 additions & 0 deletions .changeset/long-points-rest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
---
Add architecture diagram to README explaining data flow between packages.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ A collection of developer tools for the [OpenRPC](https://open-rpc.org) ecosyste
## Table of Contents

- [Overview](#overview)
- [Architecture](#architecture)
- [Packages](#packages)
- [Installation](#installation)
- [Development](#development)
Expand All @@ -28,6 +29,27 @@ OpenRPC Tools is a monorepo containing various tools and utilities for working w

The OpenRPC specification provides a way to describe JSON-RPC 2.0 APIs in a machine-readable format, similar to how OpenAPI/Swagger works for REST APIs. This repository contains React components, utilities, and applications that make working with OpenRPC documents easier.

## Architecture

The following diagram illustrates how the major packages in this repository work together and where external systems interact.

```mermaid
graph TD
A[OpenRPC Document] --> B[docs-react]
A --> C[playground]
C --> D[monaco-editor-react]
C --> E[inspector]
E --> F[JSON-RPC Server]
E --> G[logs-react]
A --> H[json-schema-to-react-tree]
A --> I[extensions]
B --> J[Browser]
D --> J
G --> J
H --> J
I --> J
```

## Packages

| Package | Description | Link |
Expand Down