Skip to content

docs: remove duplicated scan-to-gate path from architecture.md - #536

Open
IJhay-stars wants to merge 1 commit into
use-assay:mainfrom
IJhay-stars:docs/remove-pipeline-architecture-overlap
Open

IJhay-stars wants to merge 1 commit into
use-assay:mainfrom
IJhay-stars:docs/remove-pipeline-architecture-overlap

Conversation

@IJhay-stars

Copy link
Copy Markdown

Summary

  • Remove the duplicated scan-to-gate mermaid data-flow diagram from docs/architecture.md
  • pipeline.md becomes the per-asset walk-through (its existing purpose)
  • architecture.md remains the package-level map (package responsibilities, I/O confinement, dependency direction graph)
  • Add cross-references: pipeline.md → architecture.md (package-level overview) and vice versa
  • Eliminated 44 lines of duplicated content

Close #450

Acceptance criteria

  • No passage duplicated — the scan-to-gate path is now only described in pipeline.md
  • Each links the other — pipeline.md references architecture.md and architecture.md has a Cross-link section pointing to pipeline.md

Test plan

  • Verify docs/pipeline.md reads as a complete per-asset walk-through with cross-link at top
  • Verify docs/architecture.md reads as a package-level map with cross-reference section before dependency direction
  • Confirm no mermaid data-flow diagram duplicates the 6-stage pipeline description

🤖 Generated with Codebuff
Co-Authored-By: Codebuff noreply@codebuff.com

- Move per-asset walk-through to pipeline.md (the per-asset view)
- Keep package-level map and dependency direction in architecture.md
- Add cross-references between both documents
- Eliminate the duplicated mermaid data-flow diagram from architecture.md

Close use-assay#450

🤖 Generated with Codebuff
Co-Authored-By: Codebuff <noreply@codebuff.com>
@mergekeeper

mergekeeper Bot commented Oct 22, 2026

Copy link
Copy Markdown

MergeKeeper review

Scope: in scope for linked issue #450.
Verdict: clean

The PR successfully removes the duplicated scan-to-gate data flow diagram and passage from docs/architecture.md, and adds mutual cross-links between docs/architecture.md and docs/pipeline.md as requested in issue #450.

Reviewed commit: b6ac1938bf3d0ee3fdc82d06fdfd9bad0d0b4b34.
CI and merge eligibility are checked separately.

@mergekeeper mergekeeper Bot 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.

Approved

The PR successfully removes the duplicated scan-to-gate data flow diagram and passage from docs/architecture.md, and adds mutual cross-links between docs/architecture.md and docs/pipeline.md as requested in issue #450.

@mergekeeper

mergekeeper Bot commented Oct 22, 2026

Copy link
Copy Markdown

MergeKeeper merge status

Status: blocked
PR state: open
Mergeability: mergeable
Checked commit: b6ac1938bf3d0ee3fdc82d06fdfd9bad0d0b4b34.

Reason:
GitHub pull request merge request failed with 405: Repository rule violations found

4 of 5 required status checks are expected.

Next steps:
This required status check is enforced directly by the repository's branch rules, independent of MergeKeeper's own CI evaluation — a maintainer merge override cannot bypass it unless MergeKeeper is authorized to.

  1. Wait for the check to pass, or fix the underlying failure.
  2. To let an explicit override bypass this check going forward, add the MergeKeeper GitHub App as a Bypass actor on the ruleset (Settings → Rules → Rulesets → the ruleset → Bypass list).

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.

Pipeline doc and architecture doc: remove overlap

1 participant