48 Commits

Author SHA1 Message Date
Sina Atalay
8961744ebd Extract shared development and testing context into reusable skills
Move code guidelines from docs into two Claude Code skills so that
triage, solve, and review skills share a single source of truth
instead of duplicating project standards inline.

- Create rendercv-development-context skill with source code standards
  (type annotations, linting, docstrings) and codebase references
- Create rendercv-testing-context skill with test authoring standards
  (file structure, naming, parametrize, fixtures, principles)
- Remove docs/developer_guide/code_guidelines/ (content moved to skills)
- Remove Code Guidelines section from mkdocs.yaml nav
- Refactor solve-rendercv-issue, review-rendercv-pr, and
  triage-rendercv-issue to reference the shared context skills
2026-03-21 02:05:07 +03:00
Sina Atalay
021c9fbde3 Add RenderCV skill with eval framework and auto-generated docs/llms.txt
- Add SKILL.md for AI agents: YAML schema reference, entry type field
  tables, design samples per theme, CLI reference, and important patterns
  (YAML quoting, phone validation, bullet characters)
- Add Jinja2 template and generate.py that auto-generates SKILL.md and
  docs/llms.txt from live Pydantic models and sample generators
- Add promptfoo eval suite (15 tests across 4 files): cv_generation,
  pdf_parsing, design, and cli_workflow
- Add deterministic grader that validates LLM output through RenderCV's
  own pydantic pipeline (not jsonschema)
2026-03-20 20:15:09 +03:00
Sina Atalay
59c02dd957 Add ATS compatibility testing suite with PDF rendering, analysis, and reporting
- Introduced `scripts/ats_proof` directory containing tools for ATS compatibility testing.
- Added scripts for rendering PDFs, analyzing text extraction, and evaluating results against ground truth.
- Created a report generation script to summarize ATS compatibility findings.
- Updated `.gitignore` to exclude generated artifacts and added `pyproject.toml` for project dependencies.
- Included new documentation on ATS compatibility testing in `docs/user_guide/ats_compatibility.md`.
2026-03-19 22:16:56 +03:00
Sina Atalay
53c7343f2e Update web app link in docs 2026-03-06 19:00:29 +03:00
Sina Atalay
30a771f64a Docs new design 2026-02-17 22:12:27 +03:00
Sina Atalay
7aa105a3b5 Add web app to docs navbar 2025-12-23 16:31:08 +03:00
Sina Atalay
33d15d0f91 Polish docs 2025-12-10 15:36:17 +03:00
Sina Atalay
5cc5fbdf9e Massive Refactor: Architecture Redesign and Technical Debt Cleanup (#528)
* Rename `data` folder with schema

* Start refactoring data models

* Work on entry models

* Keep working on entries

* Keep working on data models

* Push old data files

* Keep working on data models

* First draft of schema.cv

* Keep working on schema

* Keep working on schema

* Improve schema.models

* Keep working on rendercv.schema

* Work on schema.design

* Keep working on rendercv.schema

* Complete variant_class_generator

* Keep working rendercv.schema

* Keep working on rendercv.schema

* Final touches to rendercv.schema

* Improve json schema descriptions in rendercv.schema

* Start working on rendercv.schema tests

* Keep implementing rendercv.schema tests

* Add more tests for rendercv.schema

* Improve rendercv.schema

* Improve docstrings and comments in rendercv.schema

* Implement better pydantic error handling in `rendercv.schema`

* Improve variant class system

* Fix rendercv.schema tests

* Start working on rendercv.templater

* Update template names

* Switching to new rendercv typst template soon

* Work on new templater

* Rename renderer with renderer_old

* Don't use utils in rendercv.schema

* Complete connections

* Update renderer folder structure

* Work on new renderer

* Work on new renderer

* Date processing on new renderer

* Improve date processing, support multiple emails, phones, and websites

* Improve markdown to Typst

* Complete entry template processing

* Time span computation in new renderer

* Better entry templates

* Setup new templates

* Improve rendercv.schema

* Start adding tests for rendercv.renderer

* New markdown parser!

* Improve markdown to typst conversion

* Finalize markdown parser

* Add new test files for rendercv.renderer

* Fix cv and connections

* Add connections test

* Improve connection tests

* Improve entry templates

* Add model processor tests

* Improve templater

* Rename old folders

* Improve schema

* Add file generation logic to renderer

* Fix naming issues

* Fix schema tests

* Add path type tests

* Add font family and typst dimension type tests

* Rename old tests

* Fix design tests

* Start integration testing of renderer

* Improve entry tempates

* Handle nested highlights properly

* Finalize Typst preamble template

* Start working on new CLI

* Remove old test files

* Implement override dictionary in new schema

* Start working on new CLI

* Better prints on render command

* New structure

* New render printer

* Add all the commands to new CLI

* Work on new command in new cli

* Improve new command

* Add error handler to new cli

* Work on create theme command

* Complete create theme command

* Remove old source files

* Improve exceptions

* Create new docs

* Add writing tests guide

* Fix cli printer and write tests

* Test copy templates

* Add app tests

* Bring back accidentally removed files

* Imporve cli and tests

* Fix path issues

* Improve

* Improve

* Add reference file comparison tests

* Fix path resolver

* Start working on test_pdf_png

* Implement comparison of multiple files (png)

* Start testing typst

* Fix templating issues

* Fix header and entry templates issues

* Implement short second rows

* Fix date issues

* Fix nested bullets and add summary

* Update testdata

* Implement footer

* Update testdata

* Reimagined design and locale schema, first iteration

* Reimagined design and locale second iteration

* Update design and locale schemas

* Adapt templater to the new design and locale

* Fix tests

* Update lib.typ and testdata for the new locale and design

* Implement proper tests with all combinations of entries

* Remove some docstrings

* fix connections logic

* Improve

* Start working on examples

* Update testdata

* Fix long second row issue

* fix templating issues

* Fix lib.typ issues

* Update testdata

* Fix clean_trailing_parts

* Update test cv

* update test cv

* Update theme defaults

* update schema and fix moderncv

* Fix moderncv issues

* Update testdata

* Update testdata and examples

* Fix issues about photo

* Fix typst photo path issues

* improve entry templates from yaml

* add new locale

* Rename writing tests doc

* Update writing tests

* Improve tests

* Add more cli tests

* Increase test coverage

* Rename variant pydantic model generator

* Improve tests

* Update testdata and improve tests

* Format, fix pre-commit errors

* Fix scripts and update entry figures

* Improve tests

* Write docstrings of schema

* Write schema docstrings

* Setup api reference

* Start working on new docs

* Work on docs

* Improve progress panel of render command

* Finalize new docs index

* Complete CLI docs

* Work on YAML input structure page

* Finalize user guide

* Start working on developer guide

* Improve api reference

* Improve developer guide

* Improve developer guide

* Improve developer gide

* Improve developer guide

* Improve developer guide

* Update developer guide

* Improve developer guide

* Improve developer guide

* Improve developer guide

* Developer guide first draft

* update developer guide

* Update examples

* Update testdata

* Handle wrong installation (rendercv instead of rendercv[full])

* Remove unnecessary files

* Write set up vs code page

* Update README.md

* Change docs description

* Compress design options gif

* minor updates

* Polish all the json schema descriptions

* Update testdata and examples

* Remove some emdashed from docs

* Add whatsapp support

* Add TestEscapeTypstCharacters to tests

* Implement custom connections

* Add page break before sections feature

* Revert page break before sections feature

* Rebase to main

* Fix social network tests, update schema
2025-12-09 17:03:56 +03:00
Sina Atalay
f6f8c490f4 Improve the documentation 2025-02-04 22:27:42 -05:00
Sina Atalay
0ddd489951 Improve hatch scripts and create executables 2025-02-04 18:53:34 -05:00
Sina Atalay
4331110c55 Upgrade to v2 (#271)
* prepare the base for typst

* rename theme folders

* rename themes

* rename themes

* update testdata with new theme names

* rename themes

* fix docs issues

* fundamentals

* fundamental renames

* generalize `create_a_latex_file`

* generalize render_a_pdf_from_latex

* make latex optional dependency, and add typst as dependency

* first tests with typst

* finish `markdown_to_typst`

* fix `markdown_to_latex`

* finish `markdown_to_typst`

* first steps towards Typst RenderCV themes

* first draft of classic theme

* start working on new design options

* work on new design options

* make default theme: "classic"

* start integrating design options with templates

* rename typst variables

* start working on connections integration

* polish connections

* polish design options and themes

* fix spelling mistakes and improve typst themes

* use ms instead of s in printer

* improve templates

* fix typos

* use ms instead of s in printer

* improve typst templates

* improve

* improve

* improve

* improve

* make PyMuPDF optional

* rename last_updated_date_style to last_updated_date_template

* revert changelog

* progress

* improve

* exclude gifs from sdist

* update tests

* improve templates

* improve templater

* data: update `sample_content.yaml`

* improve

* remove latex support

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove testdata

* remove latex

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* rename `locale_catalog` to `locale`

* docs: update developer guide faq

* add new input, rendercv_settings.date

* add show_time_span_in

* create a new function, parse_validation_errors

* improve templates

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* improve

* update templates

* fix experience entry

* improve

* finish templates

* update tests

* update testdata

* remove time_machine

* update sample content

* improve

* add sb2nov theme

* update options

* update theme.options

* update theme.options

* update theme options

* create engineeringresumes templates

* add engineering resumes

* format

* update templates

* add new theme

* fix a typo in sample content

* update templating system

* update options

* add photo support

* update workflows

* improve templates

* improve parse_validation_errors

* create a new interface for web

* fix summary

* improve

* resolve typing issues

* update mkdocs.yaml

* update pyproject.toml

* update docs scripts

* update testdata

* update tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* rename column template fields

* update

* update test data

* add moderncv

* fix problems

* moderncv

* create moderncv

* fix tests

* update

* update

* update templates

* update

* use optional dependencies

* fix

* improve

* aa

* a

* update

* update

* update

* update

* rename

* update

* update

* update

* improve

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update

* update

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* format

* update changelog

* update examples

* update entry figures

* update schema

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-01-07 01:30:40 +03:00
Sina Atalay
50cf3e7188 docs: add RenderCV icon 2024-12-25 16:15:25 -05:00
Sina Atalay
4bcf00af58 docs: improve the content (#267)
* update the developer guide

* rename changelog

* update changelog in navbar

* update readme.md

* update docs/index.md

* improve
2024-12-25 05:01:44 -05:00
Sina Atalay
62401fdfcd rename sinaatalay/rendercv to rendercv/rendercv 2024-12-09 04:30:59 -05:00
Sina Atalay
df80e06854 docs: remove unanswered faq and update sidebar 2024-12-08 19:57:29 -05:00
Sina Atalay
a223757fdb docs: rename reference to API Reference 2024-11-01 18:17:29 -04:00
Akibur Rahman
0cc14c4f45 docs: Add rendercv_settings to YAML input file structure
This commit adds the `rendercv_settings` field to the YAML input file structure in the and the `rendercv_settings.md` describing the reference of the file.
2024-09-07 06:37:01 +00:00
Sina Atalay
6bc38ee0d8 docs: add edit button 2024-07-31 21:56:28 +00:00
Sina Atalay
c2c0324b51 docs: use content.tabs.link feature of mkdocs-material 2024-07-14 15:47:52 +03:00
Sina Atalay
6dc87720bf docs: fix reference 2024-07-13 18:32:50 +03:00
Sina Atalay
14e5ca2b72 docs: update reference 2024-07-07 15:44:27 +03:00
Sina Atalay
827090da7c docs: update reference 2024-07-05 17:50:55 +03:00
Sina Atalay
e9de90ffe4 docs: update reference 2024-07-05 02:07:39 +03:00
Sina Atalay
fafa4084cf docs: update copyright and remove label field from user guide 2024-06-27 15:48:03 +03:00
Sina Atalay
c76c7207eb use Hatch as the project manager (#92) 2024-06-19 14:34:05 +03:00
Sina Atalay
4066f9e4b9 docs: update the user guide 2024-06-18 15:32:38 +03:00
Sina Atalay
75169637c3 docs: update 2024-06-17 21:57:50 +03:00
Sina Atalay
077246c097 docs: add a Google Analytics tracking ID 2024-05-19 13:10:59 +03:00
Sina Atalay
589bfc7f04 docs: add a developer guide 2024-05-19 00:45:39 +03:00
Sina Atalay
ef04e05476 docs: improve the user guide 2024-05-19 00:02:14 +03:00
Sina Atalay
e73f13e816 docs: include pymdownx.extra to mkdocs.yaml 2024-05-18 20:10:31 +03:00
Sina Atalay
fa50197015 update documentation links 2024-05-05 13:51:42 +03:00
Sina Atalay
473cc1a454 docs: change navbar order 2024-04-29 00:48:40 +03:00
Sina Atalay
28ae2aea2c docs: add engineeringresumes page 2024-04-29 00:16:50 +03:00
Sina Atalay
846725814a docs: update themes' reference documentation 2024-03-17 21:06:50 +01:00
Sina Atalay
af387e3367 docs: rename generate_entry_figures_and_examples_and_schema.py to update_rendercv_files.py 2024-03-17 20:30:57 +01:00
Sina Atalay
0d99036ede docs: fix mkdocs-macros-plugin's module_name field 2024-03-09 18:59:13 +01:00
Sina Atalay
d53e289407 docs: adjust table of contents depth of changelog 2024-02-28 21:16:48 +01:00
Sina Atalay
291b5392b2 update mkdocs.yaml 2024-02-24 22:25:53 +01:00
Sina Atalay
7041708430 update mkdocs.yaml 2024-02-24 16:20:44 +01:00
Sina Atalay
19a6c1f355 update docs 2024-02-23 18:58:53 +01:00
Sina Atalay
e64e3388ac add changelog 2024-02-19 18:55:03 +01:00
Sina Atalay
220cdac833 update folder structure of docs 2024-02-18 20:10:19 +01:00
Sina Atalay
1653ec38db update docs 2024-02-18 19:13:41 +01:00
Sina Atalay
858ae98952 docs: rename API Reference to Code Documentation 2024-01-28 19:15:53 +01:00
Sina Atalay
db22505d0a rename Code Documentation to API Reference 2023-11-26 16:40:43 +01:00
Sina Atalay
8d4b982646 update docs 2023-10-20 22:09:19 +02:00
Sina Atalay
64530a79c3 update docs 2023-10-20 20:58:43 +02:00