Skip to content

Commit 6ba5e57

Browse files
committed
Consolidate documentation: move detailed docs to docs/ directory
Reduced markdown files from 10 to 7 for better organization. Changes: - Moved ARCHITECTURE.md, DEVELOPMENT.md, MIGRATION.md to docs/ - Removed tests/README.md and docs/baseline/README.md (unnecessary) - Updated README.md with links to all documentation Final structure (7 markdown files): Root (3): - README.md (main documentation) - CONTRIBUTING.md (contribution guide) - CHANGES.md (version history) .github/ (1): - PULL_REQUEST_TEMPLATE.md (GitHub template) docs/ (3): - ARCHITECTURE.md (codebase structure) - DEVELOPMENT.md (dev setup) - MIGRATION.md (migration guide) All essential information is preserved and easier to find.
1 parent fabbf26 commit 6ba5e57

File tree

6 files changed

+9
-377
lines changed

6 files changed

+9
-377
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ cd python_prtree
192192
pip install -e ".[dev]"
193193
```
194194

195-
For detailed development setup, see [DEVELOPMENT.md](DEVELOPMENT.md).
195+
For detailed development setup, see [DEVELOPMENT.md](docs/DEVELOPMENT.md).
196196

197197
## API Reference
198198

@@ -237,6 +237,14 @@ Lars Arge, Mark de Berg, Herman Haverkort, Ke Yi
237237
SIGMOD 2004
238238
[Paper](https://www.cse.ust.hk/~yike/prtree/)
239239

240+
## Documentation
241+
242+
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - How to contribute to the project
243+
- **[CHANGES.md](CHANGES.md)** - Version history and changelog
244+
- **[docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)** - Development environment setup
245+
- **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** - Codebase structure and design
246+
- **[docs/MIGRATION.md](docs/MIGRATION.md)** - Migration guide between versions
247+
240248
## License
241249

242250
See LICENSE file for details.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/baseline/README.md

Lines changed: 0 additions & 183 deletions
This file was deleted.

0 commit comments

Comments
 (0)