You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
feat(templates): ship bilingual customization guide with exports - #69
What changed: Technical Profile & Journal now includes a bilingual CUSTOMIZE.md in the exported project root and a prominent README link. The source browser exposes the same guide.
Why: After downloading the template, users need concrete paths and examples for changing identity, projects, articles, metadata, themes, and the SVG mark.
Change Type
feat — optional customization guide in project exports
Desktop/mobile browser checks (6 passed), including guide selection, exact CSS copy, retry and close behavior
Exact-commit production build and 6 desktop/mobile checks against next start
Full CI: lint, TypeScript, unit tests, build, E2E, secret scans, and automated review
The product-truth source-pattern check accepts scaffold metadata with optional guide settings. Full CI tests pass. The first CI build encountered an intermittent error in an unchanged Google font import; the rerun and independent E2E build both passed.
Security
No secrets, credentials, or environment files committed
No client exposure of server values
Breaking Changes
None
Notes for Reviewers
Legacy source response shape and attribution remain unchanged. Guide content is exported at the project root; ZIP parity and source-browser coverage prevent missing or misplaced instructions. Server build cleanup is separate operational work and is not part of this code diff.
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Advanced
Run ID: 9b17155e-dda6-4e5e-a796-1b8e64847728
📥 Commits
Reviewing files that changed from the base of the PR and between 5134d5e and 0bcaee0.
📒 Files selected for processing: 7
app/templates/technical-profile/CUSTOMIZE.md
docs/technical-profile-template.md
lib/product-truth/audit.ts
lib/templates/export.ts
lib/templates/project.ts
tests/e2e/template-source.spec.ts
tests/unit/lib/templates-export.test.ts
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 1 remain after this review.
📝 Walkthrough
The technical-profile template gains a bilingual customization guide. Exports place the guide at the project root and link to it from the generated README. Documentation and tests cover the guide’s content, source display, and archive inclusion.
Changes: Technical-profile customization
Layer / File(s)
Summary
Customization guide and maintainer documentation app/templates/technical-profile/CUSTOMIZE.md, docs/technical-profile-template.md
Adds bilingual customization instructions, a source-file maintainer map, static-data notes, and an evidence-ledger entry.
Guide export and README link lib/templates/export.ts, lib/templates/project.ts, lib/product-truth/audit.ts
Detects CUSTOMIZE.md, exports it at the project root, conditionally adds a README link, and updates the scaffold audit check.
Guide source and archive checks tests/e2e/template-source.spec.ts, tests/unit/lib/templates-export.test.ts
Checks the guide in the source dialog, generated project, README, and downloaded archive.
The customization guide is included in exported projects and linked from the generated README. No actionable merge-blocking risk was identified in the reviewed changes.
Pre-merge checks: 4 · 1
Failed checks: 1 warning
Check name
Status
Explanation
Resolution
Docstring Coverage
Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 5 files. (2 skipped: 2…
Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed checks: 4 passed
Check name
Status
Explanation
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Title check
The title clearly and concisely describes the main change: adding a bilingual customization guide to template exports.
Description check
The description covers the required summary, rationale, change type, scope, validation, security, breaking changes, and reviewer notes. The style checklist is not applicable because this PR does not a…
Full details: Docstring Coverage
Explanation
Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 5 files. (2 skipped: 2 unsupported.)
Fix all pre-merge checks with AI
✨ Finishing Touches: 💡 2
📝 Generate docstrings: 💡
Commit to this branch
Create a new PR
🛠️ Fix failing CI checks: 💡
Commit to this branch
Create a new PR
🧪 Generate unit tests (beta)
Commit to this branch
Create a new PR
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.
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 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.
Summary
What changed: Technical Profile & Journal now includes a bilingual
CUSTOMIZE.mdin the exported project root and a prominent README link. The source browser exposes the same guide.Why: After downloading the template, users need concrete paths and examples for changing identity, projects, articles, metadata, themes, and the SVG mark.
Change Type
feat— optional customization guide in project exportsScope
Validation
The product-truth source-pattern check accepts scaffold metadata with optional guide settings. Full CI tests pass. The first CI build encountered an intermittent error in an unchanged Google font import; the rerun and independent E2E build both passed.
Security
Breaking Changes
Notes for Reviewers
Legacy source response shape and attribution remain unchanged. Guide content is exported at the project root; ZIP parity and source-browser coverage prevent missing or misplaced instructions. Server build cleanup is separate operational work and is not part of this code diff.