diff --git a/.gitignore b/.gitignore index 5d57c9a..564ab1e 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,8 @@ private/ .replit replit.nix .gitnexus + +# serverless worker secrets (nested .gitignore files are ignored by line 2, +# so these rules must live here to travel with the repo) +.dev.vars +.wrangler/ diff --git a/docs-internal/inline-comments-design.md b/docs-internal/inline-comments-design.md new file mode 100644 index 0000000..894339e --- /dev/null +++ b/docs-internal/inline-comments-design.md @@ -0,0 +1,220 @@ +# Inline Comments for Quartz — Design + +> Status: **draft / in progress** +> Owner: Corey Petty +> Companion code: `quartz/components/InlineComments.tsx`, `quartz/components/scripts/inlineComments.inline.ts`, `serverless/inline-comments-worker/` + +## Goal + +Add **inline, anchored comments** to this Quartz site — comments attached to a +specific text selection or paragraph (Medium margin-notes / Hypothes.is style), +not just one thread at the bottom of the page. It must be: + +- **Portable** — a single drop-in Quartz component + one small serverless function. +- **Backed by GitHub Discussions** — same store as the existing page-bottom + comments, so nothing is fragmented. +- **Authenticated with GitHub** — same identity model the site already uses. + +## Starting point (what already exists) + +`quartz.layout.ts` wires Quartz's built-in `Comments` component with +`provider: "giscus"`, pointed at GitHub Discussions on `logos-co/assembly` +(category _Announcements_). Giscus gives us **page-level** comments only: + +- Auth + posting happen entirely inside Giscus's hosted `