Release Notes Update: docs: update style guide and configuration

[sg-doc-holiday]

Release notes

• Updated the release notes to include changes from an external pull request
• Added a style-guide.json to the release notes documentation, detailing style and formatting guidelines for release notes

This covers 1 commits including the initial commit 9f03608.

Interaction Instructions

This PR was generated by Doc Holiday and is ready to be iterated on.

Leave comments on this pull request in plain English to guide Doc Holiday's next steps.
You might ask to:

• Update or rewrite documentation
• Create or update release notes
• Remove sections or files
• Merge this PR with another Doc Holiday PR

Examples:
@doc.holiday update these docs to follow my style guide: https://link.to/style-guide
@doc.holiday write new documentation about quantum compute and how its steam generates a 429
@doc.holiday combine this PR with #404
@doc.holiday delete this file: release-notes/file.md

[cloudflare-workers-and-pages]

Deploying britt-github-com with    Cloudflare Pages

Latest commit:	ee74353
Status:	🚫  Build failed.

View logs

[github-actions]

📚 Documentation Style Guide

Documentation Style Guide

Project Summary

Project: Hi. Welcome to brittcrawford.com.

This repository is a personal website built with Hugo (theme: hugo-coder). The site currently functions like an online business card: a short personal description and a list of links, plus a set of content sub-sections (notably a Cocktails section) and example/theme documentation shipped with the theme. The documentation in the repo includes theme docs (themes/hugo-coder/docs), exampleSite content, content pages for cocktails and other small collections, and release notes. The site uses Hugo front matter metadata (title, path, date, draft) and standard Markdown for content. The audience is primarily the site owner and contributors who will add content (posts, project pages, recipes) and maintain site configuration and theme usage. Technical complexity is low-to-moderate: content authors should know Markdown, basic YAML front matter, and Hugo conventions. There also exist API-style and technical pages inside theme docs that expect code examples, tables, and TOCs.

Purpose and goals:

• Provide a consistent, minimal, maintainable set of content and metadata rules for content authors and future contributors.
• Ensure all pages render correctly in Hugo and that links, metadata, and navigation are consistent across the site.
• Preserve examples, API snippets, and tables in a predictable format so the Hugo theme (hugo-coder) correctly generates navigation and TOCs.

Context

Project: Hi. Welcome to brittcrawford.com.
Description: This is my personal website. Right now it just has a business card-like list of links and a non-committal description. I might add more to it in the future.
Publishing System: Hugo

Primary Documentation Goals

Writing Rules

Core Principles

• Be concise - Use the minimum words necessary
• Be practical - Focus on actionable information
• Be example-driven - Show working code for every concept
• Be consistent - Match existing documentation patterns

Tone Guidelines

Default Tone (Technical Users)

• Direct and practical language
• Assume familiarity with TypeScript, package managers, CLI
• Use technical jargon and shorthand
• Focus on code examples over explanations
• Avoid marketing language or benefit statements

Non-Technical User Adjustments

When explicitly writing for non-technical users:

• Explain what each command does and why
• Spell out abbreviations and technical terms
• Provide simpler code examples with explanations
• Include more step-by-step guidance
• Link to additional learning resources

Publishing System Requirements

Hugo front matter and publishing rules

General rules:

• Every content page must start with YAML front matter delimited by --- (three dashes) at top and bottom of the block.
• Required metadata fields (present across the repository and must be provided for each page):
  • title: human-readable page title (string)
  • path: site path (string) — used i

... (truncated)

View full style guide