Skip to content

docs: add demo video and screenshot to README#4

Merged
Sathvik-Rao merged 1 commit into
mainfrom
chore-documentation
May 28, 2026
Merged

docs: add demo video and screenshot to README#4
Sathvik-Rao merged 1 commit into
mainfrom
chore-documentation

Conversation

@Sathvik-Rao
Copy link
Copy Markdown
Owner

@Sathvik-Rao Sathvik-Rao commented May 28, 2026

Summary

Embed a screenshot and demo video in the README to showcase the UI.

Type of change

  • fix: ... — bug fix → patch bump (0.0.x)
  • feat: ... — new feature → minor bump (0.x.0)
  • feat!: ... / BREAKING CHANGE — breaking change → major bump (x.0.0)
  • chore: / docs: / ci: / refactor: — no release created

PR title format

Your PR title becomes the commit message on merge and determines the version bump:

feat(resume): add cover letter section
fix: pdf export crash on empty work history
feat!: replace /generate endpoint with /build (breaking)
chore: update dev dependencies

Pattern: type(optional-scope): short description in lowercase

Checklist

  • Tests added / updated under backend/tests/ for any changed backend/app/ code
  • pytest passes locally (cd backend && pytest)
  • PR title follows the format above

@github-actions
Copy link
Copy Markdown

Suggested tests for this PR

PR title: docs: add demo video and screenshot to README

PR description:

Summary

Type of change

  • fix: ... — bug fix → patch bump (0.0.x)
  • feat: ... — new feature → minor bump (0.x.0)
  • feat!: ... / BREAKING CHANGE — breaking change → major bump (x.0.0)
  • chore: / docs: / ci: / refactor: — no release created

PR title format

Your PR title becomes the commit message on merge and determines the version bump:

feat(resume): add cover letter section
fix: pdf export crash on empty work history
feat!: replace /generate endpoint with /build (breaking)
chore: update dev dependencies

Pattern: type(optional-scope): short description in lowercase

Checklist

  • Tests added / updated under backend/tests/ for any changed backend/app/ code
  • pytest passes locally (cd backend && pytest)
  • PR title follows the format above

No backend/app/**.py files changed — no test suggestions.

@Sathvik-Rao Sathvik-Rao merged commit 28f3cf0 into main May 28, 2026
4 checks passed
@Sathvik-Rao Sathvik-Rao deleted the chore-documentation branch May 28, 2026 05:14
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