Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/components/Feedback.astro
Original file line number Diff line number Diff line change
@@ -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';
---

<p>
The draft is open for review. To comment on it, <a href={GITHUB.specsNewIssue}>open an issue in the specification
repository</a> on GitHub.<slot />
</p>
7 changes: 3 additions & 4 deletions src/pages/index.astro
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -235,7 +234,7 @@ const jsonLd = {
<section class="container sect last" aria-labelledby="paths">
<h2 id="paths">{paths.heading}</h2>
<ReaderGroups groups={paths.groups} />
<p class="feedback" id="feedback">{feedback}</p>
<div class="feedback"><Feedback /></div>
</section>
</Base>

Expand Down Expand Up @@ -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;
Expand Down
3 changes: 2 additions & 1 deletion src/pages/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ asideLinks:
---

import { DRAFT, GITHUB } from '../site.config';
import Feedback from '../components/Feedback.astro';

## What it is

Expand Down Expand Up @@ -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 <a href={GITHUB.specs}>specification repository</a>.
<Feedback> The draft and its companion documents are in the same <a href={GITHUB.specs}>repository</a>.</Feedback>

## Where to go next

Expand Down
2 changes: 2 additions & 0 deletions src/site.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Loading