Skip to content

docs: reposition as drift-killer — one YAML, resume + portfolio in sync#24

Merged
subhayu99 merged 5 commits into
mainfrom
subhayu99/docs-multimode
Apr 27, 2026
Merged

docs: reposition as drift-killer — one YAML, resume + portfolio in sync#24
subhayu99 merged 5 commits into
mainfrom
subhayu99/docs-multimode

Conversation

@subhayu99

Copy link
Copy Markdown
Owner

Summary

Repositions the project's user-facing messaging from "Portfolio Template (terminal mode + GUI mode)" to "single source of truth that ends resume↔website drift" — the actual origin story. The terminal/GUI multi-mode is reframed as a feature of the output, not the lead.

The trigger: even after the earlier rename pass (6010156), the lead pitches across surfaces still sold the visual modes ("fork this portfolio template, terminal + editorial GUI, one source") instead of the workflow pain the project solves. This PR threads the drift-killer narrative through every user-facing surface.

What changed

  • README.md — replaces tagline blockquote with ### One YAML. Resume + portfolio. Always in sync. + origin-story explainer; reorders Features list to lead with Single Source of Truth → Auto-Rendered PDF → Multi-Mode Portfolio (drops "Beautiful Terminal UI" as the first bullet); light terminology pass on body.
  • client/src/components/tui/ReplicatePage.tsx — top blurb now leads with the resume-sync story; "auto-rendered pdf resume" promoted from the 3rd to 1st bullet in "what you get".
  • client/src/components/gui/ReplicateSheet.tsx — pitch alignment, same framing.
  • docs/*.md — terminology sweep (terminal portfolioportfolio / mode-aware phrasing) across ADVANCED, DEPLOYMENT, TROUBLESHOOTING, UPGRADING. Light additions: smoke-test-both-modes callouts in MAINTAINER_GUIDE and UPGRADING; multi-mode goal added to CONTRIBUTING.
  • package.json description + vite.config.ts HTML meta description — aligned with the hook so npm metadata + OG/Twitter share cards match.

Out of scope (queued for follow-up branch)

  • "How It Works" architecture section + Mermaid diagram in README
  • "GUI Customization" section in docs/ADVANCED.md
  • FUTURE_ENHANCEMENTS.md cleanup (move completed items out)
  • Demo GIF refresh via Playwright

resume.yaml follow-up (separate, on personal)

Proposed copy for the personal_projects "Portfolio Template" entry to weave in the sync narrative is in the docs-multimode branch chat history. Not in this PR's diff because resume.yaml is gitignored on main.

Test plan

  • npm run build clean
  • npm run type-check produces same 20 pre-existing errors, none new
  • Canonical "always in sync" appears in 5 surfaces (README h3, ReplicatePage, ReplicateSheet, package.json, vite.config.ts)
  • Zero stale terminal portfolio / Beautiful Terminal UI outside literal commands
  • Live site smoke-test: open /#terminal and /#gui, hit replicate sheet, eyeball the new lead pitches

subhayu99 and others added 5 commits April 27, 2026 16:06
…io in sync

The "Portfolio Template" framing under-sold the actual product: a
single source of truth that ends resume↔website drift. Lead with that
narrative.

- Replace tagline blockquote with "One YAML. Resume + portfolio.
  Always in sync." + origin-story explainer.
- Reorder Features list: Single Source of Truth → Auto-Rendered PDF
  → Multi-Mode Portfolio → Zero-Code → show_on_resume flag → AI
  converter → themes/polish → secondary features. Drops "Beautiful
  Terminal UI" as the lead bullet.
- PWA manifest example name "Terminal Portfolio" → "Portfolio".
- Custom fields bullet acknowledges both terminal and GUI modes.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Top blurb now sells the drift-killer story (one resume.yaml drives
both a PDF resume and a multi-mode portfolio site, always in sync)
instead of "fork this portfolio template, terminal + editorial GUI,
one source."

In the "what you get" list, promote auto-rendered pdf resume from
3rd to 1st bullet — it's a co-equal output of the pipeline, not a
buried detail.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Match ReplicatePage's reposition: lead with the drift-killer story
(one resume.yaml → PDF resume + multi-mode portfolio site, always
in sync) instead of "this site is a template — fork it, ..."

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replace "terminal portfolio" / "terminal interface" / "Terminal
Portfolio" with mode-aware phrasing across the docs. Specific
edits:

- ADVANCED.md: intro now names terminal mode + GUI mode + splash
  + the build pipeline; PWA manifest example renamed; custom
  fields section calls out that GUI mode reads from the same JSON.
- DEPLOYMENT.md: intro adds the unified-output story (one workflow
  emits resume.pdf + resume.json; both modes render from JSON).
- TROUBLESHOOTING.md: drop "terminal" qualifier from intro.
- FUTURE_ENHANCEMENTS.md: custom-fields bullets acknowledge both
  modes.
- MAINTAINER_GUIDE.md: callout to smoke-test both modes after any
  engine change.
- CONTRIBUTING.md: goals line includes single-source-of-truth and
  terminal/GUI parity.
- UPGRADING.md: post-merge step adds a both-modes smoke check.

EASTER_EGGS.md left untouched — already mode-aware, internal-facing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Both surfaces still used the multi-mode framing from the earlier
rename. Update them to lead with the resume-sync hook so the npm
metadata, HTML <meta name=description>, and OG/Twitter share cards
match README + ReplicatePage + ReplicateSheet.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@subhayu99 subhayu99 merged commit 62ed0b4 into main Apr 27, 2026
2 of 4 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