Skip to content

Commit 3ef9499

Browse files
Docs: fix README project structure
- Fix README project structure to match actual files - Align comment columns in project structure Co-Authored-By: Amp <amp@ampcode.com>
1 parent 0ad404a commit 3ef9499

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,23 +90,22 @@ uv lock --upgrade # Update dependencies
9090
## Project Structure
9191

9292
```
93-
├── docs/ # MkDocs documentation source
94-
│ ├── index.md # Landing page
95-
│ ├── builtins/ # Built-in types (list, dict, set, tuple, str)
96-
│ ├── stdlib/ # Standard library modules
97-
│ ├── implementations/ # CPython, PyPy, Jython, IronPython
98-
│ └── versions/ # Python version guides (3.9–3.14)
99-
├── data/ # JSON data files
100-
│ ├── builtins.json
101-
│ └── stdlib.json
102-
├── scripts/ # Utility scripts
93+
├── docs/ # MkDocs documentation source
94+
│ ├── index.md # Landing page
95+
│ ├── builtins/ # Built-in types (list, dict, set, tuple, str)
96+
│ ├── stdlib/ # Standard library modules
97+
│ ├── implementations/ # CPython, PyPy, Jython, IronPython
98+
│ └── versions/ # Python version guides (3.9–3.14)
99+
├── data/ # JSON data files
100+
│ └── documentation_audit.json
101+
├── scripts/ # Utility scripts
103102
│ └── audit_documentation.py
104-
├── tests/ # Test files
105-
├── .github/workflows/ # GitHub Actions CI/CD
103+
├── tests/ # Test files
104+
├── .github/workflows/ # GitHub Actions CI/CD
106105
│ └── deploy.yml
107-
├── pyproject.toml # Project metadata and dependencies
108-
├── mkdocs.yml # MkDocs configuration
109-
└── Makefile # Development commands
106+
├── pyproject.toml # Project metadata and dependencies
107+
├── mkdocs.yml # MkDocs configuration
108+
└── Makefile # Development commands
110109
```
111110

112111
---

0 commit comments

Comments
 (0)