Skip to content

Streamline README and skill guidance while preserving contracts - #39

Merged
Xingdi (Eric) Yuan (xingdi-eric-yuan) merged 4 commits into
mainfrom
docs/streamline-skill-instructions
Sep 23, 2026
Merged

Xingdi (Eric) Yuan (xingdi-eric-yuan) merged 4 commits into
mainfrom
docs/streamline-skill-instructions

Conversation

@xingdi-eric-yuan

@xingdi-eric-yuan Xingdi (Eric) Yuan (xingdi-eric-yuan) commented Sep 23, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Make the README a focused entry point for users and keep the skills focused on ShadowFrog-specific instructions rather than generic execution coaching. Consolidate repeated onboarding, explanations, and examples while retaining the knowledge format and workflow contracts. No helper implementations change.

  • Explain the source-mirroring, index-free shadow design up front. Organize the README around one quick start, one linked skill table, a Dream/Nap comparison, knowledge and trust examples, installation options, and contributor references. Link advanced operations to the existing skills instead of maintaining another operations manual.
  • Combine Dream's category tables, reduce overlapping examples, and shorten repeated execution and discovery guidance without historical or evaluation asides.
  • Define Meditate's duplicate classifications once and remove its redundant worked merge example and scope-reduction claim.
  • Give Init one root-override example and shared post-init steps for the helper and manual paths.
  • Consolidate Update's symbol-change and staleness rules, preserving the user-source exception, and shorten conversational-signal examples.
  • Keep Viewer's complete command/option reference while reducing basic examples, generic presentation advice, and UI narration.
  • Tighten the core required-actions checklist and Nap overview without removing required actions, exceptions, or the independent-review boundary.

Preserved contracts

  • The skills' format-defining blocks, metadata schemas, reference invariants, and skill-selection frontmatter are unchanged.
  • The README retains Unix and Windows installation for both agents, exact staging paths, all three discovery examples and trust/property tables, Dream's tracked-shadow/writable-remote requirements, and Nap's planning-only review and spending-limit caveats. Responsible AI, license, and branding links remain.
  • Dream's broad/coherent rules, quotas, task fields, review/validation gates, pinned-tooling requirements, reconciliation, and cleanup safeguards remain explicit. The breadth-over-depth preference now sits beside the diversity rules rather than in a repeated closing checklist.
  • Discovery source trust, immediate user-knowledge capture, merge preservation rules, and label mirroring are retained.
  • Init's construction templates, reset consent, options, and explicit committed-versus-gitignored choice are retained, including the warning that gitignored shadows cannot use Dream.
  • Nap is unchanged. No helper, hook, installer, or runtime code changes are included.

Size

  • README: 583 to 317 lines and 3,293 to 1,649 whitespace-delimited words, approximately 50% fewer words.
  • Skills: six documents lose a net 1,259 words and 179 lines, a 6.9% reduction across all seven skills. Two redundant illustrative code blocks are removed, ten Viewer command examples become three, and two Init root-override examples become one existing command; all other skill fenced blocks are byte-identical to the base branch.

The changelog records this documentation-only cleanup under Unreleased.

Trim repeated explanations and examples while preserving format definitions, policy limits, review gates, and lifecycle safeguards.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Remove historical and UI narration, share Init post-creation decisions across both paths, and shorten the core Nap overview while preserving templates, approval boundaries, and safety requirements.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Consolidate installation and skill introductions, link advanced operations to the existing references, and preserve discovery examples, trust definitions, and Dream/Nap caveats.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@xingdi-eric-yuan Xingdi (Eric) Yuan (xingdi-eric-yuan) changed the title Trim repetitive skill guidance while preserving contracts Streamline README and skill guidance while preserving contracts Sep 23, 2026
Define the source-tree mirror and file/symbol lookup up front, retaining concrete discovery examples below without repeating the explanation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@xingdi-eric-yuan
Xingdi (Eric) Yuan (xingdi-eric-yuan) merged commit 4d863a3 into main Sep 23, 2026
5 checks passed
@xingdi-eric-yuan
Xingdi (Eric) Yuan (xingdi-eric-yuan) deleted the docs/streamline-skill-instructions branch September 23, 2026 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant