@atelic-action/artifact 4.2.0 → 4.2.1

package/README.md

@@ -26,7 +26,7 @@ Every export of the package, all from the one entry, `@atelic-action/artifact`.
 | `ratingCell` | A star rating table cell for a writeup table, sorted by its figure | `/writeup` |
 | `WriteupBlock`, `WriteupTopic`, `WriteupPart`, `WriteupSheet`, `WriteupSummary`, `WriteupSummaryRow`, `WriteupMarkets`, `WriteupRented`, `WriteupMark`, `WriteupCell`, `WriteupTone`, and the rest of the `Writeup*` types | The shapes a writeup's content is written in | none |
 | `WriteupGrade`, `WriteupPerson`, `WriteupShot` | The grade letter, the sign off person, and the owner's screen, shared by every document, all three re exported from ui | none |
-| `Read`, `ReadProps` | The baseline's grades explained by cause: the gist table, each row a link to its card, with an optional `note` callout over it for what the read leaves out; each section on the writeup's card (`ReadSection` extends `WriteupTopic`: the trade name linked to its definition, the one liner, the grade, the why line as the summary, the writeup's blocks, and the sources at the foot) plus the read's own today and after (a two column table) and what we recommend (a checklist). The plan, numbered and in order, sits between the gist and the cards, so the whole program reads before any one card's detail. A beat with no data is left out | `/the-read` |
+| `Read`, `ReadProps` | The baseline's grades explained by cause: the scorecard, a `ReportCard` with each row a link to its card, with an optional `note` callout over it for what the read leaves out; each section on the writeup's card (`ReadSection` extends `WriteupTopic`: the trade name linked to its definition, the one liner, the grade, the why line as the summary, the writeup's blocks, and the sources at the foot) plus the read's own today and after (a two column table) and what we recommend (a checklist). The plan, numbered and in order, sits between the gist and the cards, so the whole program reads before any one card's detail. A beat with no data is left out | `/the-read` |
 | `readLabels`, `ReadLabels` | The fixed words the read sets (Prepared for, the scorecard's screen reader words, Today, After, Recommendations, the plan's heading), each overridable through `labels` | `/the-read` |
 | `ReadTier`, `ReadSection`, `ReadChange`, `ReadStep`, `ReadPlan`, `ReadClose`, `ReadLink`, `ReadParagraph` | The shapes a read's content is written in. `ReadSection` is a `WriteupTopic` plus `gist`, `changes`, and `recommend`; its `why` and a finding's `body` take a paragraph (a string, or runs of text and links) as well as a node, so a routine can still write a read as JSON | none |
 | `Report`, `ReportProps` | The monthly page: the four questions, the seven grades now and before, the sign off, on one letter sheet | `/report` |
@@ -140,6 +140,8 @@ Static files. `vercel.json` points Vercel at `dist/client` with no framework pre
 
 A document is fixed or grown here, in `src/documents/`, with its test in `tst/documents/`, and released as a version of this package; a folder takes it with `bun update @atelic-action/artifact`. A piece a document is built from (the grade chip, the sign off, a page component, the chrome, the wall, a command) is fixed in `@atelic-action/ui` and released there first, then taken here by bumping the ui range. An improvement to the seed itself (a route, a stub file, the example content) is made here and copied into the folders by hand.
 
+A folder taking 3.0.0 moves three things in its own files, since 3.0.0 draws the read's scorecard and the writeup's overview as ui's `ReportCard` and removed the old markup with no alias. A table cell its content wrote as `<span className="rd-ranked">` becomes ui's `Rank` (`figure`, `tone`, `meaning`, `href`). A rule in its own sheets aimed at `.rd-gist-table`, `.rd-gist-card`, `.rd-gist-grade`, `.rd-gist-read`, `.rd-gist-section`, `.rd-gist-tier`, `.op-legend`, or any `.op-ov-` class matches nothing now, so it is rewritten against the card's `.rc-` classes or dropped. And a read's `labels` loses its `section` key, which the table's first column wore and the card has no use for.
+
 A folder taking 4.0.0 takes ui 3.0.0 with it (`bun update @atelic-action/artifact @atelic-action/ui --latest --cwd <short>`) and repoints its own routes, since ui 3.0.0 keeps acronyms capitalized with no alias for the old spelling: `canonicalUrl` from `@atelic-action/ui/artifact` becomes `canonicalURL` in `src/routes/index.tsx`, and the root route's `baseCss` import becomes `baseCSS`.
 
 ## Releasing

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atelic-action/artifact",
-	"version": "4.2.0",
+	"version": "4.2.1",
 	"description": "The composed documents the Atelic practice hands or sends a business (the writeup, the read, the monthly page, the note, the first call sheet, and the sealed document), built from the pieces in @atelic-action/ui",
 	"type": "module",
 	"license": "MIT",

package/src/documents/Read.tsx

@@ -34,12 +34,12 @@ import { Topic, type WriteupTopic } from "./Writeup";
  *
  * It wears the writeup's column, head, grade chip and key, tier heading,
  * section card, and close (the `.op` classes), and adds only what is its own
- * (the `.rd` classes). The gist table is drawn from the tiers, so a tier
+ * (the `.rd` classes). The scorecard is drawn from the tiers, so a tier
  * added later (Conversion, once the analytics access lands) is one more entry
- * in `tiers` and appears in the table and the body alike; until then `note`
- * says so under the table. Every prop but a finding's body and the sign off
- * person's `role` is plain data, and both are equally happy with a string, so
- * a routine can write a read as JSON.
+ * in `tiers` and appears in the scorecard and the body alike; until then
+ * `note` says so over the scorecard. Every prop but a finding's body and the
+ * sign off person's `role` is plain data, and both are equally happy with a
+ * string, so a routine can write a read as JSON.
  */
 
 /** A link inside running text: the words the reader clicks and where they go. */
@@ -57,10 +57,10 @@ export interface ReadChange {
 /**
  * One section of a tier: the writeup's section card (its `title`, `href`,
  * `oneLiner`, `grade`, `why`, `blocks`, and `sources`), plus the read's own:
- * the gist table's line, today and after, and what we recommend.
+ * the scorecard's line, today and after, and what we recommend.
  */
 export interface ReadSection extends Omit<WriteupTopic, "kind" | "why"> {
-	/** The one line in the gist table. */
+	/** The one line on the scorecard. */
 	gist: ReadParagraph;
 	/** The summary of what we saw, in one or two sentences: the why line. A paragraph, so a read written as JSON can carry links in it. */
 	why?: ReactNode | ReadParagraph;
@@ -126,9 +126,9 @@ export interface ReadClose {
 export interface ReadLabels {
 	/** The dateline's words before the business, e.g. "Prepared for". */
 	preparedFor: string;
-	/** What a screen reader calls the gist card when it has no title. */
+	/** What a screen reader calls the scorecard when it has no title. */
 	gist: string;
-	/** What a screen reader hears before a letter, on the gist card and each section's card. */
+	/** What a screen reader hears before a letter, on the scorecard and each section's card. */
 	grade: string;
 	/** What a screen reader hears for a section with no grade. */
 	notGraded: string;
@@ -169,15 +169,15 @@ export interface ReadProps {
 	lede: ReadParagraph;
 	/** The heading over the scorecard, e.g. "The Scorecard". */
 	gistTitle?: string;
-	/** The line under the scorecard's heading, e.g. what it is. */
+	/** The line under the scorecard's heading, e.g. what it is. Set only with a `gistTitle`, since it reads as the heading's subtitle. */
 	gistLead?: string;
-	/** The anchor a header stop points at for the scorecard, e.g. "scorecard". */
+	/** The anchor a header stop points at for the scorecard, e.g. "scorecard": on the heading with a `gistTitle`, on the card itself without one. */
 	gistId?: string;
 	/** A callout over the scorecard, under its heading, e.g. what the read leaves out and when it follows. */
 	note?: ReadParagraph;
 	/** The key: what each letter means, in a few words each. */
 	gradeKey?: Array<{ grade: WriteupGrade; label: string }>;
-	/** The tiers in order. Each section appears in the gist table and in the body. */
+	/** The tiers in order. Each section appears on the scorecard and in the body. */
 	tiers: ReadTier[];
 	plan: ReadPlan;
 	close: ReadClose;
@@ -294,6 +294,7 @@ function Gist({
 				</div>
 			)}
 			<ReportCard
+				id={title ? undefined : id}
 				className="rd-gist"
 				label={title ?? labels.gist}
 				legend={gradeKey}

package/src/documents/documents.css

@@ -2036,7 +2036,7 @@
 	   column, the head, the grade chip and its key, the tier heading, the
 	   section card, the screen, the close, and every print rule of the
 	   writeup's are its own already. This block adds only what the read has
-	   and the writeup does not: the gist table and the note under it, the
+	   and the writeup does not: the scorecard and the note over it, the
 	   two beats a section adds to the writeup's card (today and after, and
 	   what we recommend), and the numbered plan. It sets no @page; the writeup's, earlier in this sheet and the
 	   later of the two there, sets letter paper for every artifact page.
@@ -2065,6 +2065,7 @@
 	/* ---- the gist: the ReportCard (@atelic-action/ui), and this is its place on the page ---- */
 	.atelic-ui .rd-gist {
 		margin-top: 26px;
+		scroll-margin-top: calc(var(--nav-height) + 16px);
 	}
 	.atelic-ui .op-part + .rd-gist {
 		margin-top: 0;
@@ -2090,7 +2091,7 @@
 	.atelic-ui .rd-beat p:last-child {
 		margin-bottom: 0;
 	}
-	/* The note under the gist table: what the read leaves out, on a tinted panel with the accent's rule. */
+	/* The note over the scorecard: what the read leaves out, on a tinted panel with the accent's rule. */
 	.atelic-ui .rd-note {
 		margin-top: 18px;
 		padding: 12px 14px;