docs: drop stale placeholder banners and refresh phase references#10
Merged
Conversation
…erences Replace the four `> _Placeholder doc. Full content lands in Phase X._` notices with concrete pointers to the source files or workflows that govern each doc's subject, and update the README's `Project status` table to reflect that Phase 1 (8/8 managers) is done. Also fix one bogus `Phase 8` reference in the release checklist (Phase 8 was never a real phase). * docs/managers.md -- banner now states that all 8 managers are fully detected as of v1.0.0; the matrix below is the source of truth and is kept in sync with internal/detector/registry_*.go and the per-manager files. * docs/configuration.md -- banner now states that the schema below is the source of truth and that the Phase 5 config subsystem only adds parsing plus the `nodeup config` CLI subcommands. * docs/installation.md -- banner now states that all five channels are wired up and tested; the GoReleaser config lives in .goreleaser.yaml and the Homebrew/Scoop manifests are pushed by .github/workflows/release.yml. * docs/release-checklist.md -- replaces the bogus `Phase 8` reference with the reality that the pipeline fires on every `v*.*.*` tag push and this checklist is the human-side companion for first-stable / patch releases. * README.md -- Project status table now flags Phase 1 (8/8 managers) as done and lists the remaining phases (2, 3, 4, 5, 7) in order with a one-line description of what each delivers. * CHANGELOG.md -- new Unreleased / Changed bullet covering all of the above. No content removed, no code paths touched, no behavioral changes.
dipto0321
force-pushed
the
docs/scope-a-refresh-placeholders
branch
from
be068f8 to
04013aa
Compare
|
✔️ 04013aa - Conventional commits check succeeded. |
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
1 participant
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.
Summary
Scope A of the docs refresh — surgical placeholder-banner cleanup. Replaces four stale "Placeholder doc. Full content lands in Phase X" notices with concrete pointers to the source files or workflows that govern each doc's subject, and updates the README's
Project statustable to reflect that Phase 1 (8/8 managers) is done.No content removed. No code paths touched. Pure docs change.
Changes
Banner replacements (each was a 1–2 line
> _Placeholder doc._blockquote at the top of the file):docs/managers.mdinternal/detector/registry_*.goand the per-manager filesdocs/configuration.mdnodeup configCLI subcommandsdocs/installation.md.goreleaser.yamland.github/workflows/release.ymldocs/release-checklist.mdv*.*.*tag push; this checklist is the human-side companion for first-stable / patch releasesOther edits:
README.md—Project statustable now flags Phase 1 ✅ and lists the remaining phases (2 → 3 → 4 → 5 → 7) in order with a one-line explanation of what each phase deliversCHANGELOG.md— newUnreleased / Changedbullet covering the banner replacements + status-table updateWhy a separate PR from #9?
PR #9 was a content change — it consolidated
nodeup.mdinto README and removed dangling references. Scope A here is accuracy — the four docs still claimed "this lands later in Phase X" even though those phases are either done (Phase 1) or wrong (Phase 8 didn't exist). Splitting keeps the git history tidy: each PR has one reason to exist.Verification
CI is the same 10-check matrix as PR #9 (5 builds + lint + 3 OS tests + cog-status-check); nothing new added or removed.