feat(import): add JSON Resume import support and API documentation #39
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add JSON Resume importer module for converting JSON Resume format to simple-resume YAML. Includes comprehensive field mapping for work experience, education, skills, projects, and contact information. New features: - JSON Resume importer at core/importers/json_resume.py - JSON Schema for resume validation (shell/assets/static/schema.json) - Extended file_operations to support JSON Resume detection Documentation: - API Reference with complete module documentation - API Stability Policy defining versioning guarantees - Shell Layer APIs guide for io_utils and runtime modules - Updated Getting Started and Usage Guide Includes comprehensive test coverage for JSON Resume import scenarios. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
athola
commented
Jan 3, 2026
Convert the Shell Layer APIs architecture diagram from ASCII box-drawing to GitHub-compatible Mermaid flowchart format for better rendering. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This was referenced Jan 3, 2026
Owner
Author
PR Review Feedback AddressedAll issues from the code review have been fixed in commit In-Scope Issues (1) [FIXED]
Test Results
Issues Closed
Backlog Issues CreatedNone - All review items were in-scope. Ready for re-review. All pre-commit hooks pass. |
Update all documentation files to use declarative mood in lead sentences, replacing imperative constructions with direct statements. This change improves readability by making descriptions more natural and less instructional. Key changes: - Convert checkmark symbols (✓/✗) to "Yes"/"No" text in tables - Replace imperative verbs with declarative statements - Remove redundant legends and explanatory notes - Tighten language throughout for conciseness Affected files: - README.md, PACKAGING.md (main documentation) - wiki/*.md (all wiki pages) - src/simple_resume/core/resume.py (docstrings) - themes/README.md (theme documentation) This aligns with standard technical writing practices where descriptions state what something is rather than instructing what the reader should understand.
athola
commented
Jan 4, 2026
Remove excessive <br/> tags from Mermaid diagram node labels that were causing text overlap with data objects in GitHub's renderer. Simplified labels for cleaner rendering. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Owner
Author
PR Review Feedback AddressedThe final issue from the code review has been fixed in commit In-Scope Issues (1) [FIXED]
Test Results
Issues Closed
Issue Linkage SummaryAnalyzed 4 open issues - none related to this PR's changes (all are about LLM integration features). Backlog Issues CreatedNone - All review items were in-scope. Ready for re-review. All pre-commit hooks pass. |
Remove nested ROW1/ROW2 subgraphs from the Shell layer to simplify the Mermaid flowchart layout. Replace the generic PUBLIC→SHELL re-export edge with explicit EXPORTS→module edges for generate/, session/, and render/. This makes the architecture diagram easier to read and better represents the individual re-export relationships from the PUBLIC layer to each Shell module.
Add <br/> HTML tag to the SHELL subgraph label in the Mermaid architecture
diagram. This splits the label into two lines ("Shell Layer" and the module
path) and prevents it from overlapping with the nodes inside the subgraph.
Also adds <b> tags to emphasize the layer name for better visual hierarchy.
Remove the module path "(simple_resume.shell.*)" from the SHELL subgraph label, leaving only "Shell Layer". The shorter label eliminates the overlap issue with child nodes in the rendered Mermaid diagram. The module path is already documented in the page title and section context, so this improves clarity without losing information.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add JSON Resume importer module for converting JSON Resume format to simple-resume YAML. Includes comprehensive field mapping for work experience, education, skills, projects, and contact information.
New features:
Documentation:
Includes comprehensive test coverage for JSON Resume import scenarios.
🤖 Generated with Claude Code