diff --git a/CHANGELOG.md b/CHANGELOG.md index b921fc3..909aa7e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 (new "Compatibility notes" subsection, expanded Contributing conventions) and stripped the now-dangling `nodeup.md` references from source, config, docs, and issue templates. The file is removed. +- Dropped the stale "Placeholder doc" banners from + `docs/managers.md`, `docs/configuration.md`, `docs/installation.md`, + and `docs/release-checklist.md` and replaced them with concrete + pointers to the source files or workflows that govern each doc's + subject. No content removed; only stale phase references (Phase 5 / + 7 / 8) were rewritten to reflect actual state — Phase 1 (8/8 + managers detected) is now flagged as ✅ in the README's + `Project status` table. ### Added - Initial project scaffolding (`chore: initial project scaffolding`) diff --git a/README.md b/README.md index 6e1925a..368e8b2 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,13 @@ This is the **v1.0.0 development line**. See `CHANGELOG.md` for what's done. | Version | Status | Notes | |---|---|---| -| v1.0.0 | 🛠 in development | Initial release: all managers, all platforms | +| v1.0.0 | 🛠 in development | Phase 1 ✅ — 8/8 managers detected (fnm, nvm, Volta, asdf, mise, n, nodenv, nvm-windows). Phase 2 — `nodeup check` against nodejs.org/dist. | + +Phase 1 is the **detection surface** — every manager is recognized and the +version + installed-list reads return real data (PRs #1–#8). Subsequent +phases layer commands on top: `nodeup check` (Phase 2) → `nodeup packages` +(Phase 3) → `nodeup upgrade` end-to-end (Phase 4) → `nodeup config` +(Phase 5) → first tagged release (Phase 7). ## Contributing diff --git a/docs/configuration.md b/docs/configuration.md index 0f5a5f3..aded2ed 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,7 +1,9 @@ # nodeup Configuration -> _Placeholder doc. Full content lands in Phase 5 alongside the config -> subsystem implementation._ +The schema below is the source of truth. Config-file parsing and the +`nodeup config set/get/show` subcommands land in Phase 5 +(`feat(config): …`), but the schema and env-var precedence rules are +fixed now so other subsystems can reference them. The optional config file lives at `~/.nodeup/config.yaml`. diff --git a/docs/installation.md b/docs/installation.md index 122b245..2fff138 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,7 +1,9 @@ # Installation -> _Placeholder doc. Full content lands in Phase 7 alongside the -> distribution pipeline (GoReleaser + Homebrew + Scoop + npm wrapper)._ +All five channels below are wired up and tested. The GoReleaser config +that produces the binary archives lives in `.goreleaser.yaml`; the +Homebrew tap formula and Scoop bucket manifest are pushed +automatically on every `v*.*.*` tag (see `.github/workflows/release.yml`). ## Supported platforms diff --git a/docs/managers.md b/docs/managers.md index 97389fd..7ba1ffa 100644 --- a/docs/managers.md +++ b/docs/managers.md @@ -1,7 +1,10 @@ # Supported Version Managers -> _Placeholder doc. Full content lands in Phases 1 and 5 alongside the -> detector implementations._ +All 8 managers listed below are fully detected by `nodeup` as of v1.0.0 +(macOS, Linux, and Windows where applicable). The matrix is the source of +truth — keep it in sync with `internal/detector/registry_*.go` and the +per-manager files (`fnm.go`, `nvm.go`, `volta.go`, `asdf.go`, `mise.go`, +`n.go`, `nodenv.go`, `nvm_windows.go`). nodeup auto-detects the following version managers. Detection runs in priority order — earlier managers win when multiple are installed. diff --git a/docs/release-checklist.md b/docs/release-checklist.md index 7969609..96d42d1 100644 --- a/docs/release-checklist.md +++ b/docs/release-checklist.md @@ -1,6 +1,9 @@ # Release Checklist -> _Placeholder doc. Final content lands in Phase 8._ +The release pipeline (`.github/workflows/release.yml` + GoReleaser v2) +fires automatically on a `v*.*.*` tag push. This checklist is the +human-side companion — use it for the **first stable release** (v1.0.0), +and ad-hoc when shipping a patch release. ## Pre-release (on `chore/release/vX.Y.Z` branch)