@@ -58,11 +58,11 @@ Run all checks before committing:
5858
5959``` bash
6060# Format code
61- black src tests examples
62- isort src tests examples
61+ black src tests
62+ isort src tests
6363
6464# Check linting
65- flake8 src tests examples
65+ flake8 src tests
6666
6767# Type checking
6868mypy src --ignore-missing-imports
@@ -97,7 +97,6 @@ pytest tests/test_cache.py::TestYokedCache::test_basic_get_set
9797- Update docstrings for all public functions and classes
9898- Follow Google-style docstring format
9999- Update README.md for new features
100- - Add examples to the ` examples/ ` directory
101100- Update guides under ` site-src/pages/ ` when you change user-facing behavior
102101- Run ` pip install -e ".[docs]" ` then ` python scripts/build_docs_site.py ` to verify the static site builds
103102- Preview: ` cd site && python -m http.server 8000 ` (after copying ` CHANGELOG.md ` to ` site/changelog.md ` for the changelog page)
@@ -138,8 +137,8 @@ For new features:
1381375 . ** Run the test suite** and ensure all tests pass:
139138 ``` bash
140139 pytest
141- black src tests examples
142- flake8 src tests examples
140+ black src tests
141+ flake8 src tests
143142 mypy src --ignore-missing-imports
144143 python scripts/build_docs_site.py
145144 ```
@@ -195,7 +194,6 @@ yokedcache/
195194│ ├── exceptions.py # Custom exceptions
196195│ └── cli.py # Command-line interface
197196├── tests/ # Test suite
198- ├── examples/ # Usage examples
199197├── site-src/ # Static site sources (Markdown, templates, assets)
200198└── pyproject.toml # Project configuration
201199```
@@ -214,7 +212,7 @@ yokedcache/
214212
215213## Getting Help
216214
217- - ** Documentation:** Check the README and examples
215+ - ** Documentation:** Check the README and the docs site
218216- ** Issues:** Search existing issues or create a new one
219217- ** Discussions:** Use GitHub Discussions for questions
220218- ** Chat:** Join our community chat (link TBD)
0 commit comments