chore: touch up docs#108
Merged
Merged
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
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.
Description
Brings the README and docs site in line with the now-shipped v0.1.2
binary release: real install instructions, a mascot, brand-consistent
favicon and header logo, and Umami analytics wired up the same way
tech.weburz.com does it. No code changes — purely docs, branding, and
client-side analytics scaffolding.
Modifications
README.md— added a row of five brand-themed status badges(Release, License, Go Version, QA Checks, Go Report Card — all
styled in
burzyellow/burzblue-950to match the rest of thevisual identity) and the mascot image as a hero, placed directly
under the H1.
assets/goterox.png(new) — the Terox mascot: a Go gopher in ahard hat assembling scaffolding around translucent template files
with
{{.variable}}tokens floating around. Lives at the repo rootunder
assets/so the README renders it on GitHub via a relativepath.
docs/public/goterox.png(new) — exact mirror of the sameimage so Nuxt can serve it at
/goterox.pngfor the docs site.Two copies is intentional: avoids symlink fragility and lets each
renderer (GitHub vs. Nuxt) resolve the path from its own root.
docs/public/favicon.svg(new) — 64×64 SVG favicon: roundedburzyellow-500square with a chunky filledburzblue-950"T".Pure brand colors, no external assets.
docs/nuxt.config.ts— registered the new favicon viaapp.head.link, and addedruntimeConfig.public.umamiWebsiteId: ""so the Umami plugin can pick up the website ID from the
NUXT_PUBLIC_UMAMI_WEBSITE_IDenv var at runtime.docs/app/components/AppLogo.vue— replaced the oldstroke-based "T" with a single solid filled path so the header
logo visually matches the new favicon at every size. Same 32×32
viewBox, same design-system color tokens (
fill-primary-500,fill-neutral-900) so future brand tweaks flow throughautomatically.
docs/app/plugins/umami.client.ts(new) — Nuxt client-onlyplugin that injects the
https://umami.weburz.com/script.jstagwhen
umamiWebsiteIdis set. Direct mirror of thetech.weburz.compattern. The.client.tssuffix keeps it out ofSSR; the empty-string default in runtime config means analytics
stays off in local
pnpm devand only activates when the env varis set in the deployment.
docs/content/1.getting-started/1.introduction.md— embeddedthe mascot at the top of the introduction page so first-time
visitors are greeted by the gopher before any prose.
docs/content/1.getting-started/2.installation.md— rewrotethe page now that v0.1.2 actually ships binaries. Leads with
Homebrew (macOS/Linux) and Scoop (Windows), then direct binary
download with a checksum mention, then
go installdemoted to a"for Go developers" section, then "build from source" preserved.
Added an "Updating" table mapping each install method to its
update command. Removed the "prebuilt binaries — Not yet shipping"
callout that was no longer true. Frontmatter
descriptionupdatedto match the new reality.