Skip to content
Merged
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
13 changes: 9 additions & 4 deletions docs/06_mv3_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ The extension has no service worker or content-script registration.
6. The popup validates the injection result and fails closed if extraction did
not execute successfully.
7. The formatter creates a visible-page-only Markdown preview.
Page-derived body and comment previews remain inside blockquotes marked as
untrusted content, with dynamically sized fenced code blocks preventing
downstream Markdown renderers from activating page-supplied syntax.
The page title remains in a separate `Untrusted Page Title` section inside
a dynamically sized fenced code block. Page-derived body and comment
previews remain inside blockquotes marked as untrusted content, with the
same dynamic-fence rule preventing downstream Markdown renderers from
activating page-supplied syntax.
8. The user can copy or locally save the Markdown.

## Supported URL patterns
Expand Down Expand Up @@ -57,9 +59,12 @@ Page-derived content is rendered through `textContent` or form-control

The output includes:

- Source
- Source, containing repository, number, type, canonical URL, export timestamp,
exporter, and export mode
- Limitations
- Review Before Sharing
- Untrusted Page Title, containing the current title or explicit fallback in a
dynamically sized Markdown-inert fence
- Body Preview
- Visible Comments Preview
- Suggested Next Use
Expand Down
17 changes: 14 additions & 3 deletions docs/07_manual_verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,13 @@ If testing on private repository pages, do not paste, publish, screenshot, or sh
4. Confirm the Markdown preview includes:
- `GitHub Issue Context`
- `Source`
- the current document title and page URL under `Source`
- repository, number, type, canonical URL without query or fragment data,
export timestamp, exporter, and export mode under `Source`
- `Limitations`
- `Review Before Sharing`
- `Untrusted Page Title`, with the current document title or explicit
fallback inside a fenced code block whose delimiter is longer than any
backtick run in the title
- `Body Preview`
- `Visible Comments Preview`
- `Suggested Next Use`
Expand All @@ -76,9 +80,13 @@ If testing on private repository pages, do not paste, publish, screenshot, or sh
4. Confirm the Markdown preview includes:
- `GitHub Pull Request Context`
- `Source`
- the current document title and page URL under `Source`
- repository, number, type, canonical URL without query or fragment data,
export timestamp, exporter, and export mode under `Source`
- `Limitations`
- `Review Before Sharing`
- `Untrusted Page Title`, with the current document title or explicit
fallback inside a fenced code block whose delimiter is longer than any
backtick run in the title
- `Body Preview`
- `Visible Comments Preview`
- `Suggested Next Use`
Expand Down Expand Up @@ -120,7 +128,10 @@ Manual verification passes when:

- supported Issue pages produce a Markdown preview
- supported Pull Request conversation pages produce a Markdown preview
- Source records the current document title and page URL
- Source records repository, number, type, canonical URL, export timestamp,
exporter, and export mode
- Untrusted Page Title records the current title or explicit fallback inside a
dynamically sized Markdown-inert fence
- body and comment snippets remain inside fenced code blocks nested in blockquotes as untrusted content
- hidden or collapsed DOM content is not promoted into body or comment previews
- a visible comment is not promoted into a missing body preview
Expand Down
12 changes: 10 additions & 2 deletions docs/08_manual_verification_result_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ Notes:
- [ ] Type is `issue`.
- [ ] Number is shown.
- [ ] Page title is shown or clear fallback appears.
- [ ] Source includes the current document title and page URL.
- [ ] Source includes repository, number, type, canonical URL without query or
fragment data, export timestamp, exporter, and export mode.
- [ ] Untrusted Page Title includes the current document title or explicit
fallback in a fenced code block whose delimiter is longer than any backtick
run in the title.
- [ ] Body Preview appears or clear fallback appears.
- [ ] Visible Comments Preview appears or clear fallback appears.
- [ ] Body and comment snippets are enclosed in fenced code blocks nested in blockquotes as untrusted content.
Expand All @@ -66,7 +70,11 @@ Notes:
- [ ] Type is `pull request`.
- [ ] Number is shown.
- [ ] Page title is shown or clear fallback appears.
- [ ] Source includes the current document title and page URL.
- [ ] Source includes repository, number, type, canonical URL without query or
fragment data, export timestamp, exporter, and export mode.
- [ ] Untrusted Page Title includes the current document title or explicit
fallback in a fenced code block whose delimiter is longer than any backtick
run in the title.
- [ ] Body Preview appears or clear fallback appears.
- [ ] Visible Comments Preview appears or clear fallback appears.
- [ ] Body and comment snippets are enclosed in fenced code blocks nested in blockquotes as untrusted content.
Expand Down