Skip to content

Improve README presentation#26

Merged
shaypal5 merged 1 commit into
mainfrom
codex/improve-hletterscriptgen-readme-presentation
May 31, 2026
Merged

Improve README presentation#26
shaypal5 merged 1 commit into
mainfrom
codex/improve-hletterscriptgen-readme-presentation

Conversation

@shaypal5

Copy link
Copy Markdown
Contributor

Summary

  • Rework the root README into a clearer first-visit gateway for hletterscriptgen.
  • Add CI/license/Python/schema badges and a visual output-contract diagram.
  • Clarify repo ownership boundaries, HeOCR pipeline position, CLI usage, and the letter_set.v1 output contract.
  • Update docs/README.md with the required creator credits and remove stale wording that said the generation pipeline was not implemented.
  • Add the required creator attribution near the top and bottom of each README file.
  • Update repository metadata description and topics to match the project purpose.

Validation

  • python -m ruff check .
  • python -m mypy
  • python -m pytest
  • PYTHONPATH=src python -m hletterscriptgen validate examples/letter_set/writer_example.json
  • PYTHONPATH=src python -m hletterscriptgen schema --format json
  • README smoke check for exactly two creator mentions in each README
  • git diff --check

Milestone

No milestone assigned. The repository has roadmap milestones for implementation stages, but this PR is documentation/presentability work and does not map cleanly to a specific implementation milestone.

@shaypal5 shaypal5 added documentation Improvements or additions to documentation type:docs Documentation only labels May 31, 2026
@shaypal5 shaypal5 merged commit 793a3c2 into main May 31, 2026
7 checks passed
@shaypal5 shaypal5 deleted the codex/improve-hletterscriptgen-readme-presentation branch May 31, 2026 06:37
shaypal5 added a commit that referenced this pull request May 31, 2026
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 type:docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant