Skip to content

docs: say when to use it, and when something else fits better - #128

Merged
AlexeyShalaev merged 2 commits into
masterfrom
docs/when-to-use
Oct 27, 2026
Merged

AlexeyShalaev merged 2 commits into
masterfrom
docs/when-to-use

Conversation

@AlexeyShalaev

Copy link
Copy Markdown
Member

Summary

Adds a "When to use it, and when not" section to the README and a matching "When something else fits better" section to the docs home page.

It names the cases where another tool is the better choice: pg_partman when an extension is fine and maintenance should live in the database, TimescaleDB for time-series features, django-postgres-extra for time-only partitions in Django, a plain table when nothing expires, and PostgreSQL older than 15. It also says the library runs in production at its maintainer's company.

People arriving from an issue or a search decide in a few seconds whether to read further; this gives them an honest answer up front.

Type of change

  • Documentation update

Checklist

  • zensical build --clean passes locally, no warnings

@codecov

codecov Bot commented Oct 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AlexeyShalaev
AlexeyShalaev merged commit 65b4085 into master Oct 27, 2026
33 checks passed
@AlexeyShalaev
AlexeyShalaev deleted the docs/when-to-use branch October 27, 2026 16:17
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.

1 participant