pipeup 0.7.0 → 0.8.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,7 +5,7 @@ description: Use when creating or editing an HTML document, slide deck, report,
5
5
 
6
6
  # Add Pipeup to a page: the full reference
7
7
 
8
- Written for Pipeup 0.7.0 For a quick "add comments to this page", [pipeup-add](https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md) is the short version; this is the full reference. This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md. Its companions: [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
8
+ Written for Pipeup 0.8.0-beta.2 For a quick "add comments to this page", [pipeup-add](https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md) is the short version; this is the full reference. This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md. Its companions: [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
9
9
 
10
10
  Pipeup lets people comment on an HTML page in place: select text, click any element (including
11
11
  buttons and charts) or drop a pin on a slide. Your job is to make the page *reviewable* while it
@@ -75,7 +75,7 @@ Then choose the options (see "Options" below): usually just the defaults.
75
75
  - Just before `</body>`, add the script pinned to an exact version:
76
76
 
77
77
  ```html
78
- <script src="https://cdn.jsdelivr.net/npm/pipeup@0.7.0/dist/pipeup.min.js"
78
+ <script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.2/dist/pipeup.min.js"
79
79
  integrity="sha384-…" crossorigin="anonymous"></script>
80
80
  ```
81
81
 
@@ -157,7 +157,7 @@ Then choose the options (see "Options" below): usually just the defaults.
157
157
  - Don't wrap content in new elements or add classes for Pipeup.
158
158
  - Don't add inline styles, z-index changes or padding "for the comment column".
159
159
  - Don't load the script from anywhere but the pinned CDN URL
160
- (`https://cdn.jsdelivr.net/npm/pipeup@0.7.0/dist/pipeup.min.js`, with the `integrity` value from
160
+ (`https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.2/dist/pipeup.min.js`, with the `integrity` value from
161
161
  the release notes) or a copy of that same file next to the page. Never use an unpinned URL.
162
162
  - Don't put secrets in `data-pipeup-doc`; it *is* the document's key — anyone with the file can
163
163
  read its feedback, which is the intended audience.
@@ -175,7 +175,7 @@ page opened from disk and in any script order, and they are released with Pipeup
175
175
 
176
176
  - **Ask first, and say in plain words what it sends and to whom** (the line above, and the add-on's README). Never
177
177
  pick a sharing service yourself: the author chooses one.
178
- - Add it as one more `<script>` after Pipeup's, pinned the same way (`https://cdn.jsdelivr.net/npm/@pipeup/share@0.7.0/dist/share.min.js`
178
+ - Add it as one more `<script>` after Pipeup's, pinned the same way (`https://cdn.jsdelivr.net/npm/@pipeup/share@0.8.0-beta.2/dist/share.min.js`
179
179
  with its `integrity` from the release notes), or use the combined file `pipeup+share.min.js` instead of Pipeup's.
180
180
  - Sharing is set up by the author with the command line (`npx @pipeup/share create page.html --server …`), which writes
181
181
  `data-pipeup-share` into the file and prints a stop key once. **Never write `data-pipeup-share` yourself and never
@@ -5,10 +5,10 @@ description: Use when someone wants Pipeup reviews saved as Markdown files in th
5
5
 
6
6
  # Set up "Save to GitHub" or "Send to Git"
7
7
 
8
- Written for Pipeup 0.7.0 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-send-to-git-setup/SKILL.md.
8
+ Written for Pipeup 0.8.0-beta.2 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-send-to-git-setup/SKILL.md.
9
9
 
10
10
  Two example add-ons (written the way a company writes its own; **not** from the Pipeup project) get a review into Git as a
11
- Markdown file, the same Markdown that Copy as Markdown makes (each comment says where it is, ready for an AI to act on):
11
+ Markdown file, the same Markdown that Copy comments › As Markdown makes (each comment says where it is, ready for an AI to act on):
12
12
 
13
13
  - **Save to GitHub** needs **no server and no token**. One menu row opens GitHub's own "new file" page in a new tab with the review filled in;
14
14
  the reviewer signs in to GitHub as themselves and presses its commit button. Best to start with, and for short reviews.
@@ -1,15 +1,15 @@
1
1
  ---
2
2
  name: pipeup-summarise
3
- description: Use when someone has Pipeup feedback on an HTML page — text a reviewer copied with "Copy as Markdown" and pasted into the conversation — and wants it understood, summarised, grouped or prioritised. Read-only: produces a summary, changes nothing.
3
+ description: Use when someone has Pipeup feedback on an HTML page — text a reviewer copied with "Copy comments › As Markdown" and pasted into the conversation — and wants it understood, summarised, grouped or prioritised. Read-only: produces a summary, changes nothing.
4
4
  ---
5
5
 
6
6
  # Summarise Pipeup feedback
7
7
 
8
- Written for Pipeup 0.7.0 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
8
+ Written for Pipeup 0.8.0-beta.2 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
9
9
 
10
10
  ## 1. Get the feedback as text
11
11
 
12
- The input is the Markdown a reviewer copied with **Copy as Markdown** and pasted into the conversation, or, if you
12
+ The input is the Markdown a reviewer copied with **Copy comments › As Markdown** and pasted into the conversation, or, if you
13
13
  can run the page in a browser, `(await Pipeup.comments()).markdown` (add `{ all: true }` for resolved threads). It
14
14
  starts with `# Review comments:`. Use it directly. A thread marked "open, addressed" has an agent's note: report it as
15
15
  answered, still waiting for the author to close it. Summarising changes nothing, so don't reply in the page.
@@ -1,15 +0,0 @@
1
- import type { Identity } from "./identity";
2
- /** A new identity the reviewer can back up, and its recovery code. */
3
- export declare function makePortable(): Promise<{
4
- identity: Identity;
5
- code: string;
6
- }>;
7
- /** The recovery code of an identity that was made portable; null for an ordinary one, which can't be exported. */
8
- export declare function codeOf(identity: Identity): Promise<string | null>;
9
- export type CodeProblem = "shape" | "mistake";
10
- /** The identity a recovery code stands for, or what is wrong with the code, in a word the UI turns into a sentence. */
11
- export declare function identityFromCode(text: string): Promise<{
12
- identity: Identity;
13
- } | {
14
- problem: CodeProblem;
15
- }>;
@@ -1,27 +0,0 @@
1
- import type { CodeProblem } from "../crypto/portable";
2
- export interface IdentityDeps {
3
- /** This identity was made portable: it has a recovery code. */
4
- portable: boolean;
5
- /** The recovery code of a portable identity. */
6
- code(): Promise<string | null>;
7
- /** Makes a new portable identity, keeps it, and returns its recovery code. */
8
- make(): Promise<string>;
9
- /** Keeps the identity a code stands for, or says what is wrong with the code. */
10
- use(code: string): Promise<CodeProblem | null>;
11
- copy(text: string): Promise<void>;
12
- /** Starts over with the identity now kept (the page reloads). */
13
- reload(): void;
14
- /** Whether the comments on this page were written by the current identity (so a change is felt). */
15
- hasComments: boolean;
16
- /** The way to reach this reviewer they have shared ("" when none), and how to share or stop sharing one. */
17
- contact: {
18
- value: string;
19
- share(value: string): Promise<boolean>;
20
- stop(): Promise<void>;
21
- };
22
- }
23
- /**
24
- * A small dialog over the page for what a reviewer can do with their identity: make it portable or back it up (see the
25
- * code, copy it, save it as a file), or use one they backed up. Plain words say what each does.
26
- */
27
- export declare function openIdentity(layer: HTMLElement, deps: IdentityDeps): void;