docs: streamline README, add AGENTS.md, drop standalone deep-dive docs - #28
Closed
nodeselector wants to merge 1 commit into
Closed
docs: streamline README, add AGENTS.md, drop standalone deep-dive docs#28nodeselector wants to merge 1 commit into
nodeselector wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
⚠️ Not ready to approve
The PR title/description claims to add/refresh several docs and a skill, but the diff removes those files without replacements, so the intent and contents don’t currently match.
Pull request overview
This PR updates end-user and contributor-facing documentation for gh-actions-pin, primarily by expanding the README’s usage guidance and “How it works” explanation, and by adding repository agent guidance.
Changes:
- Expanded
README.mdwith concrete invocation examples (--rescan,--no-fix,--json=...) and a Mermaid “How it works” flowchart. - Added
AGENTS.mdwith Go style, commenting, naming, and testing guidelines for automated agents. - Removed
ARCHITECTURE.md,INTEGRATION.md, and.github/copilot/skills/cli-design-proposal/SKILL.md(note: this conflicts with the PR description/title, see comment).
File summaries
| File | Description |
|---|---|
| README.md | Replaces prior “Demo” content with expanded usage examples and an architecture-style flowchart explanation. |
| INTEGRATION.md | Deleted (previous machine-readable JSON/automation contract doc removed). |
| ARCHITECTURE.md | Deleted (previous internal architecture walkthrough removed). |
| AGENTS.md | Added agent-facing style and testing guidance aligned with Google Go + cli/cli conventions. |
| .github/copilot/skills/cli-design-proposal/SKILL.md | Deleted (removes the CLI design proposal skill content). |
Copilot's findings
- Files reviewed: 5/5 changed files
- Comments generated: 1
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
11
to
15
| ## Usage | ||
|
|
||
| Run through the UX feedback loop [here](https://github.com/github/gh-actions-pin/discussions/3). | ||
| Scan every workflow under `.github/workflows/` and pin what it can — pinning | ||
| each resolvable action to an immutable SHA and updating the lockfile: | ||
|
|
nodeselector
force-pushed
the
ns/release/docs
branch
from
June 8, 2026 03:13
b0603b7 to
e77f007
Compare
nodeselector
force-pushed
the
ns/release/cmd
branch
2 times, most recently
from
June 8, 2026 03:32
b200762 to
d538317
Compare
nodeselector
force-pushed
the
ns/release/docs
branch
2 times, most recently
from
June 8, 2026 05:39
5e7d45c to
ec83a54
Compare
nodeselector
force-pushed
the
ns/release/cmd
branch
2 times, most recently
from
June 8, 2026 05:57
27c9bf7 to
943a8b0
Compare
nodeselector
force-pushed
the
ns/release/docs
branch
3 times, most recently
from
June 8, 2026 06:16
c5296ed to
90145ac
Compare
nodeselector
changed the title
nodeselector
force-pushed
the
ns/release/cmd
branch
from
June 8, 2026 13:01
683529f to
19c22cb
Compare
nodeselector
force-pushed
the
ns/release/docs
branch
from
June 8, 2026 13:01
90145ac to
6911a8f
Compare
nodeselector
force-pushed
the
ns/release/cmd
branch
from
June 8, 2026 13:10
19c22cb to
d3fbe12
Compare
nodeselector
force-pushed
the
ns/release/docs
branch
from
June 8, 2026 13:10
6911a8f to
fbd2569
Compare
Add a concise "How it works" architecture diagram to the README and introduce AGENTS.md for contributor/agent guidance. Remove the standalone ARCHITECTURE.md, INTEGRATION.md, and the cli-design-proposal skill; the README diagram replaces the long-form architecture docs for the initial release. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
nodeselector
force-pushed
the
ns/release/docs
branch
from
June 8, 2026 13:46
fbd2569 to
c8f1ff8
Compare
nodeselector
force-pushed
the
ns/release/cmd
branch
from
June 8, 2026 13:46
d3fbe12 to
7dcc0a4
Compare
Collaborator
Author
|
Consolidated into #30. Closing this stacked PR. |
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.
Layer 6/7. Base:
ns/release/cmd.Add a concise "How it works" architecture diagram to the README and introduce
AGENTS.mdfor contributor/agent guidance. Remove the standaloneARCHITECTURE.md,INTEGRATION.md, and thecli-design-proposalskill; the README diagram replaces the long-form architecture docs for the initial release.Part of a stacked series for the pre-release hardening of
gh actions-pin. Review bottom-up; each PR is based on the one below it so the diff shows only that layer.