feat(website): make the docs site visible + complete the favicon set#52
Merged
Conversation
Two things that got under-served by the release-prep work:
1. README → docs site CTA. The docs site (heggria.github.io/taskflow)
was invisible from the README — the top badge row had npm/license/CI
badges but no link to the site we built. Add a prominent
for-the-badge '📖 Read the docs' CTA between the language switcher
and the tagline, in both README.md (→ /en) and README.zh-CN.md (→
/zh-cn). It's the only for-the-badge badge in the header, so it pops.
2. Complete favicon / icon set. The site had only favicon.svg, and
worse: under output:export + basePath, Next.js doesn't prefix
<link rel=icon>/<link rel=manifest>, so favicon.svg was 404'ing on
GitHub Pages (/favicon.svg vs the real /taskflow/favicon.svg). Fix:
- app/icon.tsx + app/apple-icon.tsx: ImageResponse PNGs (180²) reusing
the orange-tile + white-DAG brand motif (same as favicon.svg /
opengraph-image / plugin icons).
- app/manifest.ts: PWA manifest (theme color, any + maskable icons).
- layout.tsx: read TASKFLOW_BASE_PATH and prefix icon/manifest paths
explicitly (the real fix for the 404); add themeColor, appleWebApp.
- all three new routes export dynamic='force-static' (output:export).
Verified build emits /icon, /apple-icon, /manifest.webmanifest with
correct /taskflow-prefixed paths; icons are valid 180² RGBA PNGs.
3. Fix CHANGELOG: the release-prep edit accidentally renamed the
existing [0.1.5] heading to a second [0.1.6] (the defineFile/JSONC
insertion used it as an anchor). Restore 0.1.5 — now exactly one
0.1.6 and one 0.1.5, in descending order.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Three fixes that were under-served by the release-prep work.
1. README → docs site CTA (the main ask)
The docs site (
heggria.github.io/taskflow) was invisible from the README — the top badge row had npm / license / CI badges but no link to the site we built. Add a prominentfor-the-badge"📖 Read the docs" CTA between the language switcher and the tagline, in both:README.md→…/taskflow/enREADME.zh-CN.md→…/taskflow/zh-cnIt's the only
for-the-badgebadge in the header (the rest areflat-square), so it visually pops.2. Complete the favicon / icon set
The site had only
favicon.svg— and worse,favicon.svgwas 404ing on GitHub Pages. Underoutput: export+basePath, Next.js doesnt prefix<link rel="icon">/<link rel="manifest">, so the browser requested/favicon.svginstead of/taskflow/favicon.svg.app/icon.tsxImageResponsePNG (180²) — canonical browser-tab icon (Safari prefers PNG over SVG)app/apple-icon.tsxImageResponsePNG (180²) — iOS "Add to Home Screen" / Safari pinned tabapp/manifest.tsany+maskableicons, install supportlayout.tsxTASKFLOW_BASE_PATHand prefix icon/manifest paths explicitly (the real fix for the 404); addthemeColor,appleWebAppAll three new routes
export const dynamic = "force-static"(required underoutput: export). Icons reuse the orange-tile + white-DAG brand motif (same asfavicon.svg/opengraph-image/ plugin icons).Verified: build emits
/icon,/apple-icon,/manifest.webmanifestwith correct/taskflow-prefixed paths in both the HTML<link>s and the manifest body; icons are valid 180² RGBA PNGs. Pages 86 → 89.3. Fix CHANGELOG duplicate heading (spotted by @heggria)
The release-prep edit accidentally renamed the existing
[0.1.5]heading to a second[0.1.6](the defineFile/JSONC insertion used it as an anchor). Restored — now exactly one0.1.6and one0.1.5, in descending order.Checks
pnpm test— 1140/1140pnpm run typecheck— 0 errorsTASKFLOW_BASE_PATH=/taskflow pnpm run build— 89/89 pages, icons + manifest emitted with correct basePath