Skip to content

docs(51): trim repository and publish architecture artifacts - #98

Merged
sanjey99 merged 7 commits into
mainfrom
docs/51-96-postmerge-evidence
Aug 31, 2026
Merged

sanjey99 merged 7 commits into
mainfrom
docs/51-96-postmerge-evidence

Conversation

@sanjey99

@sanjey99 sanjey99 commented Aug 31, 2026 •

Copy link
Copy Markdown
Collaborator

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), add assets/Shepherd_TechJam_Track1_Architecture.png and .drawio, and delete the other 84 files.
  • Repository root: remove .impeccable/, .github/, AGENTS.md, CLAUDE.md, CONTRIBUTING.md, and SECURITY.md (10 tracked files).

Acceptance criteria

  • docs/ contains exactly the approved 15-file keep set.
  • All six requested root targets are absent.
  • The PR scope is exactly 94 deletions, one modified file (README.md), and two added architecture assets.
  • All 22 remaining README local links/images resolve and all 8 documented npm scripts exist.
  • README contains no references to deleted documentation or root files.
  • Editable Draw.io source is a valid one-diagram mxfile and its committed blob matches the Downloads source exactly (4680C7C684DFAA98926EB3E79075C5E922BB21BC9EC37A5E3260A1AA87BD53B9).
  • Rendered dark PNG is 4277x2256 and its committed blob matches the Downloads source exactly (25C98591CE37ABBFC12497A053D301AB31197E26FCF42E0841C42E63BC55CF68).
  • npm run typecheck and npm run build passed on a3e8500; later commits modify only README.md and add the two architecture assets.
  • Full local npm run check outcome recorded: typechecks passed; root scripts were 19/26 with seven Windows/POSIX fixture failures (pipefail\r, spawn ENOENT, and spawn UNKNOWN), so the chained Server/Web test and build stages were not reached.
  • No hosted checks registered for the final head because the approved change deletes the repository workflow files.

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

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.
@sanjey99

Copy link
Copy Markdown
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
@sanjey99 sanjey99 changed the title docs: record issue 96 protected-main evidence docs(51): finalize protected-main evidence and README Aug 31, 2026
## 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`
@sanjey99 sanjey99 changed the title docs(51): finalize protected-main evidence and README docs(51): trim repository to hackathon artifacts Aug 31, 2026
## 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 sanjey99 changed the title docs(51): trim repository to hackathon artifacts docs(51): trim repository and publish architecture artifacts Aug 31, 2026
@sanjey99
sanjey99 marked this pull request as ready for review August 31, 2026 16:37
Copilot AI lite review requested due to automatic review settings August 31, 2026 16:37
@sanjey99
sanjey99 merged commit f8bb2ea into main Aug 31, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@sanjey99
sanjey99 deleted the docs/51-96-postmerge-evidence branch August 31, 2026 16:37
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.

2 participants