Skip to content

docs(pdf): the cv.md shape the CV checks read, Pandoc output included, and "title check did not run" - #158

Open
vliggio wants to merge 1 commit into
career-ops-hq:mainfrom
vliggio:claude/prep-doc-updates-4880
Open

vliggio wants to merge 1 commit into
career-ops-hq:mainfrom
vliggio:claude/prep-doc-updates-4880

Conversation

@vliggio

@vliggio vliggio commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Documents what career-ops-hq/career-ops#4880 shipped (merged as 2b3fb67): the three CV checks read Pandoc-flavored cv.md through one shared helper, cv-title-check no longer prints a green check after comparing nothing, and doctor warns when cv.md has no Experience section the checks can read. The site described cv.md only as "standard sections" and said nothing about the shape the checks depend on.

What changes

One new section, "How your cv.md is read", on the pdf mode page, before "Gotchas". English, Spanish, French and German.

  • What the three checks do (title consistency, structure, skill gap) and that all three find jobs and skills by heading.
  • The shape they need, with a short example taken from examples/cv-example.md: the five accepted experience-section names, the ### Company — Location job heading and its accepted separators, the bold title line, the dates line.
  • Skills headings: any heading containing "Skills"; "Tools", "Technologies" and "Tech Stack" on a level-1 or level-2 heading only; every matching section is read.
  • A cv.md converted from a Word file with Pandoc is read as it is (bold and small-caps headings, ---/-- dashes, trailing \ breaks).
  • What the reader sees when the checks cannot find their jobs: title check did not run instead of a green check, and the npm run doctor warning, which is a warning and never a failure.

Each statement was checked against lib/cv-markdown.mjs, cv-title-check.mjs, jd-skill-gap.mjs, doctor.mjs, modes/pdf.md and AGENTS.md on core main after the merge, not against the PR as first reviewed.

One sentence that is not in the core PR text

"These heading names are matched in English, even when the rest of your CV is in another language." It follows from the regexes (EXPERIENCE_HEADING_RE in lib/cv-markdown.mjs, SKILLS_WORD_RE / TOOLS_WORD_RE in jd-skill-gap.mjs), which match English words only. It matters most to readers of the translated pages, who are the likeliest to have a cv.md with ## Experiencia or ## Berufserfahrung.

Scope

The FAQ answer "How do I give career-ops my CV?" is the other natural home for the shape. It is left alone here because several open pull requests already edit faq.mdx and src/lib/faq-data.ts.

Translations

translationHash is restamped on es, fr and de to the new English hash (6c9e87b81634e369). All three matched the previous English hash (16914eae2d8e7aa4) before this change, so the restamp is accurate. The three translations were written with Claude and have not had a native-speaker read. The example cv.md block stays in English in every language, because the headings in it are the ones the checks match.

Merge order

A sibling pull request (#157) adds a second section to the same four files for career-ops-hq/career-ops#4764. Whichever merges second needs a rebase and a restamp. With both sections in place (this one first, then the ATS section), the English hash is ec87532bd085bfa0.

Checks

  • npm run types:check: passes
  • npm run build: passes

🤖 Generated with Claude Code

…, and "title check did not run"

Documents what career-ops-hq/career-ops#4880 shipped (merged as 2b3fb67):
the three CV checks read Pandoc-flavored cv.md through one shared helper,
cv-title-check no longer prints a green check after comparing nothing, and
doctor warns when cv.md has no Experience section the checks can read.

One new section on the pdf mode page, "How your cv.md is read": the shape
the checks need, the accepted section names, that a cv.md converted from a
Word file with Pandoc is read as it is, and what you see when the checks
cannot find your jobs.

English, Spanish, French and German. translationHash restamped to the new
English hash (6c9e87b81634e369); all three matched the previous one.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 10, 2026

Copy link
Copy Markdown

@vliggio is attempting to deploy a commit to the Career Ops OSS Program Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Oct 10, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 34 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Repository: career-ops-hq/career-ops-docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 2e8ff0a3-47cb-46e6-9525-53d412b9121c

📥 Commits

Reviewing files that changed from the base of the PR and between f217ca5 and 7f56b9c.


📒 Files selected for processing (4)
  • content/docs/reference/modes/pdf.de.mdx
  • content/docs/reference/modes/pdf.es.mdx
  • content/docs/reference/modes/pdf.fr.mdx
  • content/docs/reference/modes/pdf.mdx


  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
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