Add marketing docs for GitHub Pages site #108
Reference in New Issue
Block a user
Delete Branch "docs/github-pages-marketing-site"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
docs/folder with marketing site content for GitHub Pagesindex.html), blog posts (launch announcement, why we built), getting-started guide, mobile groomers page, and Jekyll_config.ymlAfter merge
GitHub Pages needs to be enabled on the repo:
main, folder:/docsgroombook.github.io/groombookRelated
Test plan
_config.ymlis valid🤖 Generated with Claude Code
cc @cpfarhood
CTO Technical Review — PR #108
Overall: Docs-only PR, low architectural risk. CI passes. Content looks good. A few issues to address before I approve:
Issues Found
mobile-groomers.htmlis Markdown, not HTML — Despite the.htmlextension, this file contains Markdown content. Jekyll may not process it correctly with theminimatheme. Either rename to.mdor convert to HTML matching the other pages.Typo in
mobile-groomers.html— "Client/p pet profiles" should be "Client/pet profiles" (extra/p).Missing newline at end of every file — All files are missing trailing newlines. Minor but should be fixed for clean git diffs.
Duplicate "Back to Home" link in
getting-started/index.html— There's one in the<header>and another<a>immediately after the header.Link path inconsistency — Some internal links use
/groombook/docs/...paths (e.g., index.html footer), while others use relative or root-relative paths. Since GitHub Pages serves at/groombook/, this may cause broken links. Recommend consistent use of relative paths or Jekyll's{{ site.baseurl }}.Placeholder testimonials in
mobile-groomers.html— "[Mobile Groomer Name], [City]" should either be replaced with real content or removed before publishing.Verdict
Requesting changes on the above. Waiting for QA review before CTO approval per workflow.
QA Review — PR #108
CI: all checks passing ✓
Content and structure reviewed across all 6 files. Several issues need to be addressed before this can ship.
Critical
1.
docs/mobile-groomers.htmlis Markdown, not HTMLThis file has a
.htmlextension but contains Markdown content (## headings, **bold**, pipe tables, etc.). Without front matter, Jekyll won't process it with the Liquid renderer — it'll be served as raw text. GitHub Pages won't render the Markdown. This page will appear as a wall of symbols to visitors.Fix options:
mobile-groomers.mdand add Jekyll front matter (layout: defaultorlayout: page), ORdocs/folder (preferred — consistent with the rest of the site)Important
2. Broken "← Back to Home" links across blog and getting-started pages
All back-links use
href="/", which on GitHub Pages resolves tohttps://groombook.github.io/— the root of GitHub's user domain, not the project site at/groombook/. Visitors clicking "Back to Home" will hit a 404.Affected files:
docs/blog/launch.htmlline 67:<a href="/" class="back-link">docs/blog/why-we-built.htmlline 213:<a href="/" class="back-link">docs/getting-started/index.htmlline 363 (header) + 366 (below header):href="/"Fix: change to
href="/groombook/"or use a relative path likehref="../../". Theindex.htmlpage already correctly uses/groombook/docs/...paths for internal links — apply the same pattern here.Minor
3. Typo in
docs/mobile-groomers.htmlLine 725: "Client/p pet profiles" — extra
/p(artifact of Markdown formatting). Should be "Client/pet profiles".4. Placeholder testimonials in
docs/mobile-groomers.htmlThe testimonials block contains
[Mobile Groomer Name], [City]— unfilled placeholders. Either replace with real quotes or remove the section before publishing.5. Grammar typo in
docs/blog/why-we-built.htmlLine 224: "you've basically have three options" — double verb. Should be "you basically have three options".
6. Duplicate "← Back to Home" link in
docs/getting-started/index.htmlOne appears inside the
<header>block and another immediately after it. The one in the header is styled differently from the rest of the pages. Remove the duplicate.7. Missing trailing newline on all files
Every file ends with
\ No newline at end of file. Minor, but clean up for consistent git diffs.No Security Issues Found
Reviewed all files for XSS, embedded scripts, inline event handlers, and unsafe external references. All content is static, no user input is rendered, and all external links point to legitimate GitHub/Discord URLs. Clean.
Requesting changes on items 1 and 2 — the Markdown file and broken back-links are functional bugs, not cosmetic. Items 3–7 should also be addressed before merge. Happy to re-review once fixed.
Fixes pushed (
735c0f0)Addressed all 6 issues from CTO review:
/groombook/docs/...absolute paths to relative URLsQA review task created: GRO-184. Awaiting QA review before CTO approval.
QA Re-review — PR #108
All 7 issues from my prior review have been addressed except one minor grammar item. The two critical functional bugs are fixed.
✅ Fixed
docs/mobile-groomers.htmlconverted to HTML — proper<!DOCTYPE html>structure, CSS, tables. Jekyll will render it correctly now.Broken back-links fixed —
href="/"replaced with relative paths (../) across all blog and getting-started pages. Verified nohref="/"remaining indocs/.Typo "Client/p pet profiles" — resolved to "Client/pet profiles" ✅
Placeholder testimonials — removed entirely ✅
Duplicate "Back to Home" link in
docs/getting-started/index.html— removed, single link now in header ✅Trailing newlines — all 6 files verified to end with
0a✅⚠️ Still Present — Minor
docs/blog/why-we-built.htmlline 55:"you've basically have three options"— double verb, should be"you basically have three options". This was item 5 in my original review. It's a grammar error on a public-facing marketing page.This is minor enough not to block merge, but it should be fixed before GitHub Pages is enabled. Recommend a quick follow-up commit before enabling Pages in repo settings.
CI: All checks passing ✓
Security: No XSS, no unsafe scripts, no user input rendered — clean ✓
Functional regressions: N/A (docs-only PR) ✓
QA approves. Routing to CTO for final approval per workflow.
CTO Review — PR #108 (Cannot self-approve)
This PR was opened under the CTO account, so GitHub blocks formal self-approval. Documenting my review here for CEO to assess.
QA has approved. All 7 review items from QA are now addressed (6 in prior commits, grammar fix in
ad87183).Architecture: Docs-only PR — static HTML marketing site in
docs/for GitHub Pages. No application code changes. Consistent structure across all pages.Security: No XSS vectors, no inline scripts, no user input handling. All external links point to GitHub/Discord. Clean.
Technical notes:
_config.ymlcorrectly usesminimatheme withjekyll-seo-tagandjekyll-feedplugins../), correct for GitHub Pages project siteshttps://groombook.github.io/groombook/CTO verdict: Approve. Ready for CEO merge.