diff --git a/src/components/Feedback.astro b/src/components/Feedback.astro new file mode 100644 index 0000000..718340e --- /dev/null +++ b/src/components/Feedback.astro @@ -0,0 +1,15 @@ +--- +/** + * The one sentence that says how to comment on the draft: GitHub issues on the specification + * repository. The home page closes on it and the Introduction's "Reviewing the draft" section opens + * with it, so the channel is named in one place. Text in the slot follows the sentence in the same + * paragraph. + * + */ +import { GITHUB } from '../site.config'; +--- + +

+ The draft is open for review. To comment on it, open an issue in the specification + repository on GitHub. +

diff --git a/src/pages/index.astro b/src/pages/index.astro index ac8d3a8..ed9da83 100644 --- a/src/pages/index.astro +++ b/src/pages/index.astro @@ -3,6 +3,7 @@ import Base from '../layouts/Base.astro'; import AnatomyDemo from '../components/AnatomyDemo.astro'; import CodeBlock from '../components/CodeBlock.astro'; import ReaderGroups from '../components/ReaderGroups.astro'; +import Feedback from '../components/Feedback.astro'; import { term } from '../lib/term'; import { DRAFT, GITHUB, RESTACTD_DOCS, SITE } from '../site.config'; @@ -141,8 +142,6 @@ $ curl 'localhost:8080/v1/notes/42¦wordCount?input=one%20two%20three' more: { label: 'The same verb in JavaScript and Python', href: '/start/' }, }; -/* The feedback channel is an open decision, so this note stays unlinked. */ -const feedback = 'The draft is open for review. A channel for comments has not been chosen yet.'; /** Split a sentence so paths and identifiers render in monospace; the words are unchanged. */ const CODEY = /(\/[A-Za-z0-9_.\-\/:]*[A-Za-z0-9_]|notes\/42:wordCount|notes\/42|restact_code)/g; @@ -235,7 +234,7 @@ const jsonLd = {

{paths.heading}

- +
@@ -367,7 +366,7 @@ const jsonLd = { .measure > p + p { margin-top: 12px; } - /* The comments note: the channel is undecided, so it is plain text under the reader groups. */ + /* The comments note under the reader groups: how to comment on the draft (the Feedback component). */ .feedback { max-width: 68ch; margin-top: 32px; diff --git a/src/pages/introduction.mdx b/src/pages/introduction.mdx index 36cd56f..f1aad8f 100644 --- a/src/pages/introduction.mdx +++ b/src/pages/introduction.mdx @@ -12,6 +12,7 @@ asideLinks: --- import { DRAFT, GITHUB } from '../site.config'; +import Feedback from '../components/Feedback.astro'; ## What it is @@ -56,7 +57,7 @@ The reference implementation is [restactd](/restactd/), a server written in Rust ## Reviewing the draft -The draft is open for review. A channel for comments has not been chosen yet. The draft and its companion documents are in the specification repository. + The draft and its companion documents are in the same repository. ## Where to go next diff --git a/src/site.config.ts b/src/site.config.ts index 2c29db8..bf78baa 100644 --- a/src/site.config.ts +++ b/src/site.config.ts @@ -30,6 +30,8 @@ export const DRAFT = { export const GITHUB = { specs: 'https://github.com/stackumi/restact', + /** Where readers comment on the draft (the Feedback component links it). */ + specsNewIssue: 'https://github.com/stackumi/restact/issues/new', restactd: 'https://github.com/stackumi/restactd', /** `restact mcp`, the MCP bridge in the restact command line (formerly verbsmith). */ mcp: 'https://github.com/stackumi/restactd/blob/main/cli/docs/mcp/README.md',