pipeup 0.8.0-beta.4 → 0.8.0-beta.5
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.
- package/README.md +2 -2
- package/dist/addons.json +1 -1
- package/dist/pipeup.agents.js +2 -2
- package/dist/pipeup.core.js +1 -1
- package/dist/pipeup.esm.js +1 -1
- package/dist/pipeup.min.js +1 -1
- package/dist/types/core.d.ts +2 -2
- package/package.json +1 -1
- package/skills/pipeup-add/SKILL.md +2 -2
- package/skills/pipeup-apply/SKILL.md +1 -1
- package/skills/pipeup-integrate/SKILL.md +7 -5
- package/skills/pipeup-send-to-git-setup/SKILL.md +1 -1
- package/skills/pipeup-summarise/SKILL.md +1 -1
package/dist/types/core.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export declare const VERSION = "0.8.0-beta.
|
|
1
|
+
export declare const VERSION = "0.8.0-beta.5";
|
|
2
2
|
/** The day this version was made (set with the version): Pipeup says so, once, in the console when it is over a year old. */
|
|
3
|
-
export declare const BUILT = "2026-10-
|
|
3
|
+
export declare const BUILT = "2026-10-18";
|
|
4
4
|
export { PipeupDocument, UnsavedChangeError, type Listener, type OpenOptions } from "./document";
|
|
5
5
|
export { DEFAULT_PROFILE_NAME, MemoryStore, loadOrCreateProfile, type OpStore, type Profile, } from "./storage/store";
|
|
6
6
|
export { IndexedDbStore } from "./storage/indexeddb";
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ description: Use when someone asks you to add comments to an HTML page, make it
|
|
|
5
5
|
|
|
6
6
|
# Add Pipeup to this page
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.0-beta.
|
|
8
|
+
Written for Pipeup 0.8.0-beta.5 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md) (the full reference: layouts, decks, tabs, every option), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md) (answering the comments) and [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
|
|
9
9
|
|
|
10
10
|
Pipeup lets people comment on an HTML page in place. **When the page already exists, never change its layout, styling or behaviour to make room for Pipeup**: it draws in its own layer, and you only add attributes and one script tag. Edit the HTML file only; don't download, fetch or run anything yourself.
|
|
11
11
|
|
|
@@ -14,7 +14,7 @@ Pipeup lets people comment on an HTML page in place. **When the page already exi
|
|
|
14
14
|
1. **Pin the script.** Just before `</body>`:
|
|
15
15
|
|
|
16
16
|
```html
|
|
17
|
-
<script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.
|
|
17
|
+
<script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.5/dist/pipeup.min.js"
|
|
18
18
|
integrity="sha384-…" crossorigin="anonymous"></script>
|
|
19
19
|
```
|
|
20
20
|
|
|
@@ -5,7 +5,7 @@ description: Use when someone asks you to act on Pipeup feedback for an HTML pag
|
|
|
5
5
|
|
|
6
6
|
# Apply Pipeup feedback
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.0-beta.
|
|
8
|
+
Written for Pipeup 0.8.0-beta.5 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
|
|
9
9
|
|
|
10
10
|
## 1. Read the comments
|
|
11
11
|
|
|
@@ -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.8.0-beta.
|
|
8
|
+
Written for Pipeup 0.8.0-beta.5 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.8.0-beta.
|
|
78
|
+
<script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.5/dist/pipeup.min.js"
|
|
79
79
|
integrity="sha384-…" crossorigin="anonymous"></script>
|
|
80
80
|
```
|
|
81
81
|
|
|
@@ -136,7 +136,9 @@ Then choose the options (see "Options" below): usually just the defaults.
|
|
|
136
136
|
a handler so choosing one can go there: `Pipeup.onReveal((view) => showTab(view.tab))`. Pipeup
|
|
137
137
|
never opens tabs or accordions itself; without a handler the comment opens on its own with a
|
|
138
138
|
snapshot of what it was on. The handler receives the whole view (every key you set, plus `slide`
|
|
139
|
-
on decks); `label` is only a display name.
|
|
139
|
+
on decks); `label` is only a display name. Report only *where* the reviewer is (a tab, a route, a step),
|
|
140
|
+
never a revision, version or date: those change for every comment already made, which then counts as
|
|
141
|
+
somewhere else.
|
|
140
142
|
|
|
141
143
|
8. **Check, and fix until it passes:** once it ships, run `npx pipeup check page.html`; until then, open the page and check the items below by eye. Fix every `fail`; fix
|
|
142
144
|
`warn` items unless the author says otherwise. Typical fixes:
|
|
@@ -157,7 +159,7 @@ Then choose the options (see "Options" below): usually just the defaults.
|
|
|
157
159
|
- Don't wrap content in new elements or add classes for Pipeup.
|
|
158
160
|
- Don't add inline styles, z-index changes or padding "for the comment column".
|
|
159
161
|
- Don't load the script from anywhere but the pinned CDN URL
|
|
160
|
-
(`https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.
|
|
162
|
+
(`https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.5/dist/pipeup.min.js`, with the `integrity` value from
|
|
161
163
|
the release notes) or a copy of that same file next to the page. Never use an unpinned URL.
|
|
162
164
|
- Don't put secrets in `data-pipeup-doc`; it *is* the document's key — anyone with the file can
|
|
163
165
|
read its feedback, which is the intended audience.
|
|
@@ -175,7 +177,7 @@ page opened from disk and in any script order, and they are released with Pipeup
|
|
|
175
177
|
|
|
176
178
|
- **Ask first, and say in plain words what it sends and to whom** (the line above, and the add-on's README). Never
|
|
177
179
|
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.8.0-beta.
|
|
180
|
+
- Add it as one more `<script>` after Pipeup's, pinned the same way (`https://cdn.jsdelivr.net/npm/@pipeup/share@0.8.0-beta.5/dist/share.min.js`
|
|
179
181
|
with its `integrity` from the release notes), or use the combined file `pipeup+share.min.js` instead of Pipeup's.
|
|
180
182
|
- Sharing is set up by the author with the command line (`npx @pipeup/share create page.html --server …`), which writes
|
|
181
183
|
`data-pipeup-share` into the file and prints a stop key once. **Never write `data-pipeup-share` yourself and never
|
|
@@ -5,7 +5,7 @@ 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.8.0-beta.
|
|
8
|
+
Written for Pipeup 0.8.0-beta.5 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
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):
|
|
@@ -5,7 +5,7 @@ description: Use when someone has Pipeup feedback on an HTML page — text a rev
|
|
|
5
5
|
|
|
6
6
|
# Summarise Pipeup feedback
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.0-beta.
|
|
8
|
+
Written for Pipeup 0.8.0-beta.5 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
|
|