Skip to content

docs: polish README, add production screenshots, CHANGELOG/CONTRIBUTING and validate CI#1

Merged
CreatmanCEO merged 1 commit into
mainfrom
polish-readme-and-meta
May 6, 2026
Merged

docs: polish README, add production screenshots, CHANGELOG/CONTRIBUTING and validate CI#1
CreatmanCEO merged 1 commit into
mainfrom
polish-readme-and-meta

Conversation

@CreatmanCEO

Copy link
Copy Markdown
Owner

Summary

Wave-2 polish for B-tier ecosystem repos. README/meta only — no source code touched.

  • README rewritten: badges, why/how, tech stack, production screenshot gallery from @ai_zhanna_assistant, limitations, Related ecosystem block, author block
  • docs/screenshots/ added with 3 production screenshots (live psychology knowledge-base bot)
  • CHANGELOG.md reconstructed from git log (Keep a Changelog)
  • CONTRIBUTING.md with priority list and PR checklist
  • .github/workflows/validate.yml — py_compile on src/ and tests/, meta-files presence, README section checks, screenshots presence, pyproject TOML validation

Test plan

  • CI green on this PR
  • README renders correctly on github.com (screenshots load)
  • All ecosystem links resolve

Notes

  • No source code or config changes
  • No file deletions
  • License unchanged (MIT)

…idate CI

Wave-2 polish for B-tier repos:
- README rewritten: badges row, why/how/limitations, tech stack table,
  production gallery, Related Claude Code ecosystem block, expanded
  author block
- docs/screenshots/ added — 3 production screenshots from
  @ai_zhanna_assistant (live psychology knowledge-base bot)
- CHANGELOG.md reconstructed from git history (Keep a Changelog)
- CONTRIBUTING.md with priority list and PR checklist
- .github/workflows/validate.yml: py_compile on src/ and tests/,
  meta-files presence, README sections, screenshots presence,
  pyproject TOML validation

No source code changes.
@CreatmanCEO CreatmanCEO merged commit 5fbb09c into main May 6, 2026
1 check passed
@CreatmanCEO CreatmanCEO deleted the polish-readme-and-meta branch May 6, 2026 14:44
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