From c6343480b81357b473c586cb8d200e31e279d09e Mon Sep 17 00:00:00 2001 From: Thomas Schmelzer Date: Mon, 17 Aug 2026 12:00:28 +0400 Subject: [PATCH] docs: correct the README project-structure tree The tree showed src/core/, src/data/, src/api/ and src/web/, but the packages live under src/pycharting/. It also listed a top-level data/ directory for "sample CSVs and fixtures" that does not exist, and omitted docs/, which does. The fence carried no language tag, so nothing could check it. Tagging it text clears the last untagged fence reported by check_doc_examples.py. Closes #85 Co-Authored-By: Claude Opus 5 (1M context) --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5ac5b72..a2bce9e 100644 --- a/README.md +++ b/README.md @@ -247,16 +247,17 @@ For a detailed technical deep dive into the architecture, data flow, rendering p The library follows a modern `src/` layout: -``` +```text pycharting/ ├── src/ -│ ├── core/ # Chart server lifecycle and internals -│ ├── data/ # Data ingestion, validation, and slicing -│ ├── api/ # FastAPI routes and Python API surface -│ └── web/ # Static frontend (HTML + JS for charts) -├── tests/ # Test suite -├── data/ # Sample CSVs and fixtures -└── pyproject.toml # Project configuration +│ └── pycharting/ +│ ├── core/ # Chart server lifecycle and internals +│ ├── data/ # Data ingestion, validation, and slicing +│ ├── api/ # FastAPI routes and Python API surface +│ └── web/ # Static frontend (HTML + JS for charts) +├── tests/ # Test suite, mirroring src/pycharting/ +├── docs/ # MkDocs sources, incl. how-it-works.md +└── pyproject.toml # Project configuration ``` ## Contributing