feat(docs): dumpsock.hartle.tech/{docs,wiki} via GHA Pages + Apache-2.0 OSS license + brand theme #8

Merged
hartle-tech merged 1 commit from feature/oss-docs-hosting into develop 2026-05-15 20:54:54 +00:00
hartle-tech commented 2026-05-15 20:54:40 +00:00 (Migrated from github.com)

Summary

First slice of the multi-product docs platform. DumpSock becomes the template — future products get this exact shape (LICENSE + NOTICE + FUNDING.yml + GHA Pages workflow + branded VitePress).

What you get after merge

  • dumpsock.hartle.tech/docs/ — public marketing/user docs (external VitePress, brand-themed)
  • dumpsock.hartle.tech/wiki/ — dev notes (internal VitePress, public-but-unindexed, INTERNAL banner)
  • dumpsock.hartle.tech/ — meta-refresh to /docs/ for now
  • Repo is now PUBLIC + Apache 2.0 + sponsor button visible on the repo

Brand theme (from operator's mockups.zip)

  • #E74C3C primary red, #1A1A1A ink, #FCFEFB sock-white, #A5A8AC mid-gray
  • Inter body + IBM Plex Serif headings (slab feel) + JetBrains Mono code
  • Soft rounded feature cards with red hover lift
  • Internal site has an 'INTERNAL · DEV NOTES · public-but-unindexed' top banner

Donations (operator action)

.github/FUNDING.yml ships with all entries commented out. Uncomment each as you create the corresponding account (GitHub Sponsors needs approval; Ko-fi/Liberapay/Buy-Me-a-Coffee are instant). The 'Sponsor' button on the repo lights up as soon as any entry is uncommitted.

DNS (separate PR in hartle.tech-terraform)

This PR doesn't include DNS — that lives in the other repo. Follow-up PR there adds 4 CF A records for dumpsock.hartle.tech → GitHub Pages IPs. Caddy on the VPS doesn't get touched (Pages serves the subdomain, not Caddy).

Test plan post-merge

  • GHA Deploy docs workflow runs green
  • Pages deployment URL serves a built site (initially at the github.io URL, then at custom domain after DNS lands)
  • After CF DNS PR: dig +short dumpsock.hartle.tech returns the 4 GH Pages IPs
  • curl -sI https://dumpsock.hartle.tech/docs/ returns 200 with VitePress markers
  • curl -sI https://dumpsock.hartle.tech/wiki/ returns 200, page has noindex meta + INTERNAL banner visible
  • curl -sI https://dumpsock.hartle.tech/ returns 200 with meta-refresh to /docs/
  • robots.txt at root has Allow:/docs/ + Disallow:/wiki/
## Summary First slice of the multi-product docs platform. DumpSock becomes the **template** — future products get this exact shape (LICENSE + NOTICE + FUNDING.yml + GHA Pages workflow + branded VitePress). ## What you get after merge - `dumpsock.hartle.tech/docs/` — public marketing/user docs (external VitePress, brand-themed) - `dumpsock.hartle.tech/wiki/` — dev notes (internal VitePress, public-but-unindexed, INTERNAL banner) - `dumpsock.hartle.tech/` — meta-refresh to /docs/ for now - Repo is now PUBLIC + Apache 2.0 + sponsor button visible on the repo ## Brand theme (from operator's mockups.zip) - #E74C3C primary red, #1A1A1A ink, #FCFEFB sock-white, #A5A8AC mid-gray - Inter body + IBM Plex Serif headings (slab feel) + JetBrains Mono code - Soft rounded feature cards with red hover lift - Internal site has an 'INTERNAL · DEV NOTES · public-but-unindexed' top banner ## Donations (operator action) `.github/FUNDING.yml` ships with **all entries commented out**. Uncomment each as you create the corresponding account (GitHub Sponsors needs approval; Ko-fi/Liberapay/Buy-Me-a-Coffee are instant). The 'Sponsor' button on the repo lights up as soon as any entry is uncommitted. ## DNS (separate PR in hartle.tech-terraform) This PR doesn't include DNS — that lives in the other repo. Follow-up PR there adds 4 CF A records for `dumpsock.hartle.tech` → GitHub Pages IPs. Caddy on the VPS doesn't get touched (Pages serves the subdomain, not Caddy). ## Test plan post-merge - [ ] GHA `Deploy docs` workflow runs green - [ ] Pages deployment URL serves a built site (initially at the github.io URL, then at custom domain after DNS lands) - [ ] After CF DNS PR: `dig +short dumpsock.hartle.tech` returns the 4 GH Pages IPs - [ ] `curl -sI https://dumpsock.hartle.tech/docs/` returns 200 with VitePress markers - [ ] `curl -sI https://dumpsock.hartle.tech/wiki/` returns 200, page has noindex meta + INTERNAL banner visible - [ ] `curl -sI https://dumpsock.hartle.tech/` returns 200 with meta-refresh to /docs/ - [ ] robots.txt at root has Allow:/docs/ + Disallow:/wiki/
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
hartle-tech/dumpsock!8
No description provided.