@shllg/emend 0.2.0 → 0.4.0

package/dist/skills/emend-publish/SKILL.md

@@ -17,7 +17,7 @@ Also use it when the user asks to publish or share a document, or to read one on
 A document the user asks you to publish may live in the repository.
 Do not publish unasked a file the task adds to the repository, such as docs, specs or tasks.
 Do not use it for source code, for a hunk-review HTML writeup (see "Publish") or for anything the user wants kept out of emend.
-If you already wrote the document elsewhere, such as in a temporary folder, copy it into a doc root as step 1 says.
+If you wrote it elsewhere, copy it into a doc root as step 1 says.
 
 ## Steps
 
@@ -27,9 +27,9 @@ If you already wrote the document elsewhere, such as in a temporary folder, copy
    emend renders Markdown on its server: GFM tables, code colours, and ```` ```mermaid ```` fences become diagrams.
    An HTML document's own scripts never run, and nothing loads from other hosts.
    Use no CDN scripts, styles or fonts.
-   In an HTML document, keep images and styles beside the file and reference them with relative paths.
-   Markdown documents show no local images yet, so use HTML when the document needs images.
-   Keep the document out of hidden folders, because a folder publish skips dotfiles and hidden folders.
+   For HTML, keep images and styles beside the file, using relative paths.
+   Markdown shows no local images yet; use HTML for images.
+   Keep it out of hidden folders: folder publishing skips dotfiles and hidden folders.
    Tell the user the path of the file you wrote.
 2. Publish it with the command under "Publish" below.
    Stdout is the review URL alone.
@@ -45,9 +45,17 @@ If you already wrote the document elsewhere, such as in a temporary folder, copy
 
 ## Publish
 
-Run the command from the repository that holds the document.
-Or give a path under a folder the user allowed as a doc root.
-Use a short, plain title. A title that starts with `--` is refused.
+Run from the document's repository, or name a path under a doc root the user allowed.
+Use a short, plain title; titles starting with `--` are refused.
+
+`emend publish <file>` also takes any UTF-8 text file: config, script, SQL or log.
+It shows these as source with line comments. Add `--source` to show Markdown or HTML as source.
+A folder walk skips secret-looking filenames (not Markdown or HTML), binary, oversized or unreadable
+files, text shown as source holding a private key, and folders named `secret(s)` or `credential(s)` in any case below the folder argument.
+Below a folder argument, HTML assets in those folders or holding a private key are skipped too; other assets are not checked.
+Explicit file or folder arguments publish as named; never name a credential file or secrets folder.
+Warnings stop after 20 (`SHORTCUT_LIMITS.warnings`), then count further skips.
+Each folder argument gets a published-file count.
 
 If an emend error line mentions an agent sandbox, show the user that line and stop.
 Do not run emend another way, retry it outside the sandbox, ask for escalated permissions,

package/dist/skills/emend-review/SKILL.md

@@ -172,7 +172,7 @@ A writeup can show images, such as before and after screenshots of a UI change.
 - List it under `media` in the manifest with a `path` and a `source`.
 - Reference it from any writeup section with `![Alt](path)`. The alt text becomes the caption.
 - Put a before and an after image in one paragraph, with alt text "Before" and "After", to show them side by side.
-- Use PNG, JPEG, GIF, WebP or AVIF only. Each file is at most 8 MiB. A review holds at most 50.
+- Use PNG, JPEG, GIF, WebP or AVIF only. Each file is at most 25 MiB. A review holds at most 50.
 - Only listed paths render. Any other image reference in the writeup is dropped.
 - Remote image URLs do not show. List the file under `media` instead.
 - Images do not render in Markdown docs.
@@ -198,7 +198,10 @@ Each ref must be unique within its topic.
 
 Read [the manifest example](references/manifest.md) before creating the manifest. Replace the
 synthetic values with the review's paths, commit hashes and text. Docs use `source` only when
-their local filename differs from the published path.
+their local filename differs from the published path. Choose each doc's optional `view`:
+`"rendered"` (the default for Markdown and HTML) or `"source"` for literal text with line comments.
+Any other UTF-8 text file is a doc shown as source with line comments. One path may appear once
+rendered and once as source; you decide per file.
 When the work has a pull request, fixes an issue or opened one, add each URL to `links` with a
 short label such as `PR #42`. Use only URLs you have seen; never guess one. The review header
 shows them. When emend knows the repository's web address (see `repoUrl` in the manifest

package/dist/skills/emend-review/references/manifest.md

@@ -136,7 +136,10 @@ It must end in the same kind of extension as `path`.
 A doc's `source` must be inside the repository's worktree or inside a folder the user listed in
 `docRoots` in emend's own configuration.
 When publish prints `source is outside the allowed doc roots`, stop and ask the user to run `emend config add docRoots <folder>` for that folder, or to move the doc into the repository. Never run `emend config` or edit emend's configuration yourself.
-Markdown docs render as safe blocks. Use Markdown for the writeup, not an HTML page.
+A doc's optional `view` is `"rendered"` or `"source"`. Markdown and HTML render by default;
+use `"source"` to read their literal text with line comments. Any other UTF-8 text file is a doc
+shown as source with line comments. One path may appear once rendered and once as source.
+Choose the view per file. Markdown renders as safe blocks; the writeup stays Markdown.
 
 Set optional `main` to `"writeup"` or a declared doc path to choose the opening page, even with an empty writeup.
 Without `main`, the app opens a nonempty writeup, then the first doc in manifest order, then the diff, or Writeup if nothing exists.
@@ -160,7 +163,7 @@ Each entry is `{ "path": "media/before.png", "source": ".shots/before.png" }`.
 - Reference it from any writeup section with `![Alt](path)`. The alt text becomes the caption.
 - Put a before and an after image in one paragraph, with alt text "Before" and "After", to show them side by side.
 - Use PNG, JPEG, GIF, WebP or AVIF only. The source must end in the same extension as `path`.
-- Each file is at most 8 MiB. A review holds at most 50.
+- Each file is at most 25 MiB. A review holds at most 50.
 - `path` has no segment that starts with `.`, has no `:` and is unique.
 - Remote image URLs do not show. List the file under `media` instead.
 - Only listed paths render. Images do not render in Markdown docs.