Skip to content

docs: sync README/SUPPORT_MATRIX/CHANGELOG with actual repo inventory - #45

Merged
yeongseon merged 1 commit into
mainfrom
docs/sync-inventory-versions
Aug 13, 2026
Merged

docs: sync README/SUPPORT_MATRIX/CHANGELOG with actual repo inventory#45
yeongseon merged 1 commit into
mainfrom
docs/sync-inventory-versions

Conversation

@yeongseon

Copy link
Copy Markdown
Contributor

Summary

Fixes documentation drift found in the code↔docs sync audit (#42). Docs now match what is actually on disk and in CI.

Changes

  • README
    • Add existing-but-undocumented examples: quickstart/5min-sqlalchemy, templates/flask (11 recipes), templates/django, fundamentals/pycubrid (16), fundamentals/sqlalchemy (7), fundamentals/pandas (6).
    • Refresh Templates table, Fundamentals table, Framework Map, and Project Structure tree to reflect the real directory layout.
  • SUPPORT_MATRIX
    • Recipe total corrected 55/5862 (actual sum of the category table: 16+7+6+11+12+5+1+4).
    • Python 3.12 marked as CI default (both ci.yml and smoke-test.yml run 3.12); 3.10 reframed as supported minimum.
  • CHANGELOG
    • Remove false "Multilingual README support (6 languages)" claim — only English README.md exists.

Verification

  • Directory inventory cross-checked against disk.
  • Version facts confirmed: Python 3.12 in CI, CUBRID 11.2 in compose/CI.
  • grep confirms no lingering 55/58 recipe claims or multilingual references.

Closes #42

- README: document existing but unlisted examples (quickstart/5min-sqlalchemy,
  templates/flask, templates/django, fundamentals/pycubrid, sqlalchemy, pandas);
  refresh Templates table, Fundamentals table, Framework Map, and Project
  Structure tree to match disk.
- SUPPORT_MATRIX: correct recipe total (55/58 -> 62, actual sum of category
  table) and mark Python 3.12 as the CI default (CI runs 3.12, not 3.10).
- CHANGELOG: remove false multilingual README claim (only English README.md
  exists).

Closes #42
@yeongseon
yeongseon merged commit 70b7ab9 into main Aug 13, 2026
6 checks passed
@yeongseon
yeongseon deleted the docs/sync-inventory-versions branch August 13, 2026 13:33
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.

docs: sync README/SUPPORT_MATRIX/CHANGELOG with actual code and CI

1 participant