Repository navigation
docs(51): trim repository and publish architecture artifacts - #98
Merged
Merged
Conversation
Summary: Reconcile the release ledger and test report after PR #97 merged as 53f2529. Change: - Record exact post-integration repository, coverage, browser, Terraform, live-preflight, and hosted results. - Move issue #96 findings from candidate to integrated while preserving independent UI, security, external Ark, and rehearsal gates. - Correct the stale OPS-06 compose-exposure status. Testing: - Local Markdown links resolve across all five changed documents. - git diff --cached --check passes. - Exact merge gates are recorded from the clean 53f2529 worktree.
This was referenced Aug 31, 2026
Collaborator
Author
|
Hosted verification on exact head 0a15a90 is green: Pull request checks / Required checks run 33408256285 passed in 2m54s; Required checks / Node 22 / npm run check run 33408256333 passed in 3m05s. Local pre-push also passed root 26/26, Server 856 passed plus 3 explicit skips, Web 20/20, strict typechecks, and both builds. The PR remains draft pending explicit approval to publish it for review; the unchecked independent/external/rehearsal gates remain intentionally open. |
Summary: - make Shepherd and its Track 1 middleware story the repository entry point - retain the Starter Kit setup, lifecycle, Playground, persistence, deployment, and security contract Change: - document the problem, three primitives, trusted architecture, deterministic judge flow, human-decision path, and preserved live Agent flow - add current Shepherd evidence screenshots, validation commands, configuration, limitations, future work, and authoritative document links Testing: - README integrity: 31 local links/images, 8 npm scripts, 4 shell entrypoints, and 24 PRD/Starter Kit requirements verified - git diff --check passed - bounded secret/private-path scan passed - GitNexus staged change analysis: 1 file, 0 affected processes, low risk - npm run check reached tests under Node 24; 7 Windows/CRLF POSIX-fixture failures are recorded in the PR
## Summary Remove the requested optional APP_AUTH_TOKEN paragraph from the quick-start documentation. ## Change - README.md: delete only the unlock-screen and .env note while preserving the remaining configuration guidance. ## Testing - README integrity: 31 local links/images and 8 npm scripts validated - git diff --cached --check
## Summary Remove the requested Honest limitations and future work section from README.md. ## Change - README.md: delete the section in full while preserving the following documentation index. ## Testing - README integrity: 30 local links/images and 8 npm scripts validated - Both requested text blocks confirmed absent - git diff --cached --check
## Summary Reduce the repository documentation surface to the approved Hackathon v2 artifacts and retained UI assets. ## Change - `docs/`: keep only `assets/`, `UI.jpeg`, `hackathon-v2-skeleton.xml`, and numbered `hackathon-v2-section-*.xml` files - Root: remove `.impeccable/`, `.github/`, `AGENTS.md`, `CLAUDE.md`, `CONTRIBUTING.md`, and `SECURITY.md` - `README.md`: make the overview and runbook self-contained and link only retained artifacts ## Testing - Exact docs keep set: 13 files - Staged scope: 94 deletions and one modified file - README integrity: 18 local links/images and 8 npm scripts validated - `npm run typecheck` - `npm run build`
## Summary Add the latest editable Shepherd Track 1 architecture diagram to the retained Hackathon assets. ## Change - `docs/assets/Shepherd_TechJam_Track1_Architecture.drawio`: add the validated diagrams.net source unchanged - `README.md`: link the diagram from the Architecture section and Hackathon artifacts list ## Testing - Source and staged Git blob match exactly - SHA-256: `4680C7C684DFAA98926EB3E79075C5E922BB21BC9EC37A5E3260A1AA87BD53B9` - Valid `mxfile` with one diagram - README integrity: 20 local links/images and 8 npm scripts validated - `git diff --cached --check`
## Summary Render the latest Shepherd Track 1 architecture directly in the README while retaining its editable Draw.io source. ## Change - `docs/assets/Shepherd_TechJam_Track1_Architecture.png`: add the original dark-background export unchanged - `README.md`: embed the diagram above the editable-source link and list the PNG under Hackathon artifacts ## Testing - Source and staged Git blob match exactly - PNG dimensions: `4277x2256` - SHA-256: `25C98591CE37ABBFC12497A053D301AB31197E26FCF42E0841C42E63BC55CF68` - README integrity: 22 local links/images and 8 npm scripts validated - `git diff --cached --check`
sanjey99
marked this pull request as ready for review
August 31, 2026 16:37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Linked issue: #51
Reduce the repository to a self-contained README and the explicitly retained Hackathon v2 artifacts, including the latest rendered and editable Track 1 architecture diagram. This follow-up supersedes the earlier documentation-evidence layout in this PR.
Files
README.md: remove links to deleted material, retain the product overview and operating instructions inline, embed the latest architecture PNG, link its editable Draw.io source, and link every retained Hackathon v2 XML artifact.docs/: keep the original 13-file set (assets/create-agent.jpg,assets/playground.jpg,UI.jpeg,hackathon-v2-skeleton.xml, and sections 1–9), addassets/Shepherd_TechJam_Track1_Architecture.pngand.drawio, and delete the other 84 files..impeccable/,.github/,AGENTS.md,CLAUDE.md,CONTRIBUTING.md, andSECURITY.md(10 tracked files).Acceptance criteria
docs/contains exactly the approved 15-file keep set.README.md), and two added architecture assets.mxfileand its committed blob matches the Downloads source exactly (4680C7C684DFAA98926EB3E79075C5E922BB21BC9EC37A5E3260A1AA87BD53B9).4277x2256and its committed blob matches the Downloads source exactly (25C98591CE37ABBFC12497A053D301AB31197E26FCF42E0841C42E63BC55CF68).npm run typecheckandnpm run buildpassed ona3e8500; later commits modify onlyREADME.mdand add the two architecture assets.npm run checkoutcome recorded: typechecks passed; root scripts were 19/26 with seven Windows/POSIX fixture failures (pipefail\r,spawn ENOENT, andspawn UNKNOWN), so the chained Server/Web test and build stages were not reached.Operational impact
Deleting
.github/removes the repository-defined GitHub Actions workflows, issue templates, and pull-request template after merge. No application source, tests, dependencies, or runtime configuration changed.Ready-for-review SHA:
0d2b7795e35e5c999589acafb4d03b1a0141df2c