Skip to content

README: document images_skipped and the cover-collage endpoints, drop the stale MVP checklist #5

Closed

Description

@ftymoshchuk

The README is also the PyPI project page, so these gaps show there until the next release.

  • POST /api/jobs/generate response: the field list under "Endpoint Descriptions" is missing images_skipped (int), added in Redesign the UI in a hand-drawn style, with a clearer flow #3. It counts files that could not be read as images; the UI reads it for its "Skipped N files that couldn't be read" note.
  • Cover-collage endpoints: POST /api/jobs/generate-cover-collage and POST /api/jobs/generate-cover-collage-batch exist (src/pasteup/routes/jobs.py), but neither has an entry under "Endpoint Descriptions". /docs describes them. The README should at least list them with their main request fields:
    • single: collage_template, selected_cover_images;
    • batch: parent_folder_path, created_output_root_path, selected_subfolders.
  • "Acceptance Checklist (MVP Scope)": a list of unticked boxes for features that all ship in 0.1.0, so it reads as unfinished. CHANGELOG.md now records what each release contains, so the section can go.

Done when the README matches the API and the checklist is gone; the next release carries it to PyPI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions