Skip to content

docs: fix inaccurate claims in README.md#3688

Merged
crivetimihai merged 1 commit intomainfrom
update-docs-1.0
Mar 24, 2026
Merged

docs: fix inaccurate claims in README.md#3688
crivetimihai merged 1 commit intomainfrom
update-docs-1.0

Conversation

@crivetimihai
Copy link
Copy Markdown
Member

Summary

  • Python version: Fixed prerequisite from ≥ 3.10 to ≥ 3.11 (matches pyproject.toml requires-python = ">=3.11,<3.14")
  • Docker Compose Quick Start: Default docker-compose.yml uses PostgreSQL (via pgbouncer), not MariaDB — fixed instructions, database description, and Admin UI URL (port 8080 via nginx)
  • Table count: Updated from "36+" to "55+" (verified 55 __tablename__ entries in db.py)
  • Tests count: Updated from "400+" to "15,000+" (verified 15,000+ test functions across 483 test files)
  • Makefile targets: Removed outdated "75+" count (actual count is in the hundreds)
  • SECURE_COOKIES default: Fixed from true to false in Project Defaults table (.env.example sets false for dev; section describes values that differ from code defaults)
  • Protocol version example: Updated from 2025-06-18 to 2025-11-25 (current default in config.py)

Test plan

  • Verify README renders correctly on GitHub
  • Confirm Docker Compose Quick Start instructions work with default docker-compose.yml

@crivetimihai crivetimihai added this to the Release 1.0.0 milestone Mar 20, 2026
@crivetimihai crivetimihai added SHOULD P2: Important but not vital; high-value items that are not crucial for the immediate release documentation Improvements or additions to documentation labels Mar 20, 2026
- Python version: ≥ 3.10 → ≥ 3.11 (matches pyproject.toml requires-python)
- Docker Compose: fix Admin UI URL to port 8080 (via nginx)
- Table count: 36+ → 55+ (actual __tablename__ count in db.py)
- Tests count: 400+ → 7,000+ (actual test function count)
- Makefile targets: remove outdated "75+" count
- SECURE_COOKIES dev default: true → false (matches .env.example)
- Protocol version example: 2025-06-18 → 2025-11-25 (current default)

Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
@crivetimihai crivetimihai merged commit 1fdcdda into main Mar 24, 2026
4 checks passed
@crivetimihai crivetimihai deleted the update-docs-1.0 branch March 24, 2026 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation SHOULD P2: Important but not vital; high-value items that are not crucial for the immediate release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant