i'm writing proper docs for git-pages; does this style of writing look good? does it communicate the point well?
Conversation
Notices
-
Embed this notice
✧✦Catherine✦✧ (whitequark@mastodon.social)'s status on Sunday, 07-Dec-2025 17:08:54 JST
✧✦Catherine✦✧
-
Embed this notice
✧✦Catherine✦✧ (whitequark@mastodon.social)'s status on Sunday, 07-Dec-2025 19:08:41 JST
✧✦Catherine✦✧
@lesley you can push updates via HTTP or forge webhooks
-
Embed this notice
Lesley Lai (lesley@mastodon.gamedev.place)'s status on Sunday, 07-Dec-2025 19:08:42 JST
Lesley Lai
@whitequark I think maybe a bit more explanation of the project's purpose for the uninformed? Like Caddy can also serve static files, so what does git-pages add on top of it?
-
Embed this notice
✧✦Catherine✦✧ (whitequark@mastodon.social)'s status on Sunday, 07-Dec-2025 20:20:38 JST
✧✦Catherine✦✧
@JoachimSchipper I'm thinking the "selling points" will be on the frontpage, and this will be a page for people who already decided they want to run it
-
Embed this notice
Joachim Schipper (joachimschipper@infosec.exchange)'s status on Sunday, 07-Dec-2025 20:20:39 JST
Joachim Schipper
@whitequark This is good!
One optional suggestion for the second sentence: I care much less about “written in Go” than about “runs the popular grebedoc service” (i.e. actually works, and also here is a demo.)
(Yes, Go does matter, but it’s not the third thing I want to know about this.)
One more optional suggestion: you might also want to be more explicit about the webhook angle; a very classic Apache config also serves static pages and accepts updates from the site author, but it’s usually not too hard to figure out whether one wants classic Apache or this software.
-
Embed this notice