Skip to content

DOC: update to documentation + small clean up of legacy code #74

Open
YektaY wants to merge 4 commits intomainfrom
yektay/clean-up
Open

DOC: update to documentation + small clean up of legacy code #74
YektaY wants to merge 4 commits intomainfrom
yektay/clean-up

Conversation

@YektaY
Copy link
Copy Markdown
Collaborator

@YektaY YektaY commented Apr 22, 2026

Description

documentation overhaul:

  • dedupe the documentation
  • deletes legacy content
  • replace ASCII diagrams with light/dark images
  • correct for drift against the code.

Motivation

The docs had accumulated significant duplication (quickstart / architecture lived in 3–4 places), orphaned references to scripts that no longer exist, and several protocol and schema-level inaccuracies that would actively mislead anyone writing a client.

Closes #34
Closes #24

Where Has This Been Documented?

The change itself is documentation

Pre-merge checklist

  • Code works interactively
  • Code contains descriptive docstrings
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions

@YektaY YektaY self-assigned this Apr 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] - Update docs + readme [BUG] - Unclear/inconsistent documentation

1 participant