Skip to content

feat(templates): ship bilingual customization guide with exports - #69

Merged
AnxForever merged 1 commit into
mainfrom
docs/template-customization-20261014
Oct 14, 2026
Merged

AnxForever merged 1 commit into
mainfrom
docs/template-customization-20261014

Conversation

@AnxForever

@AnxForever AnxForever commented Oct 14, 2026 •

Copy link
Copy Markdown
Owner

Summary

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

Scope

  • Templates / Animations
  • Documentation

Validation

  • Secret scan, lint and TypeScript checks
  • Template export/source route checks (32 passed); product-truth/export regression checks after audit update (12 passed)
  • 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.

@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to 0bcae

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: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning 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 Passed checks: 4 passed
Check name Status Explanation
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title clearly and concisely describes the main change: adding a bilingual customization guide to template exports.
Description check Passed 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.

❤️ Share

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

@AnxForever
AnxForever merged commit 0d0c56f into main Oct 14, 2026
12 of 13 checks passed
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