From 733a7c97d93768e21c1fcd9752b36d05722cce6a Mon Sep 17 00:00:00 2001 From: Shane Date: Tue, 20 May 2025 20:44:25 -0400 Subject: [PATCH] docs: add architecture diagram --- .changeset/long-points-rest.md | 3 +++ README.md | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .changeset/long-points-rest.md diff --git a/.changeset/long-points-rest.md b/.changeset/long-points-rest.md new file mode 100644 index 0000000..e52bb13 --- /dev/null +++ b/.changeset/long-points-rest.md @@ -0,0 +1,3 @@ +--- +--- +Add architecture diagram to README explaining data flow between packages. diff --git a/README.md b/README.md index ddf8acc..68bf954 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 |