docs(install): document upcoming Go-module migration + replace install command (#37) #1

claude-ceo-assistant · 2026-05-07T06:33:20Z

2026-05-07 06:33:20 +00:00

What

README-only doc PR for internal#37. Documents the upcoming Go-module-path migration to users + provides a build-from-source workaround until the cross-repo Go-module PR lands.

Per orchestrator's Q5 answer: cross-repo Go-module migration is filed as a separate parked follow-up. This PR does NOT bundle the go.mod / .go file rewrites. Bundling them would create a half-state where docs say one module path and code says another.

Changes (1 file: README.md)

Section	Before	After
Install	`go install github.com/Molecule-AI/molecule-cli/...@latest`	"Migration in progress" callout + build-from-source instructions + future `go install git.moleculesai.app/molecule-ai/...` command. The github.com command no longer resolves (org gone); the new command needs the Go-module migration to land first.
Releases link	`https://github.com/Molecule-AI/molecule-cli/releases` (404)	Removed; note about Gitea Actions releases pipeline being restored.
RFC #10 link	`https://github.com/Molecule-AI/molecule-cli/issues/10` (404)	`git.moleculesai.app/molecule-ai/molecule-cli/issues/10` + note that the original lived on suspended GitHub.

Remaining github.com/Molecule-AI literal in the migration callout is narrative text describing the suspended org, not a clickable URL — intentional.

Files NOT touched in this PR

Per orchestrator scope decision (Q5):

go.mod (module declaration)
25+ .go files with github.com/Molecule-AI/molecule-cli/internal/... import paths
known-issues.md:96 (describes current module path; consistent with go.mod)
CLAUDE.md:37 (declares current module path; consistent with go.mod)

These all live in the cross-repo Go-module migration PR (parked follow-up). Reviewer should check that this PR's grep-after only matches narrative text, not active import paths.

Verification

$ grep -nE 'github\.com/Molecule-AI' README.md
10:> **Migration in progress** (2026-05-07): the `github.com/Molecule-AI`

The single remaining match is the org-name in narrative text; no clickable URL link to the suspended org remains.

DoD waivers

Doc-only PR. No tests / security / observation / migration / version bump.
Back-compat: the new go install git.moleculesai.app/... command is documented as not yet functional pending the Go-module PR. Users coming from the suspended-GitHub command get a working build-from-source path immediately.

Hostile self-review (3 weakest spots)

go install git.moleculesai.app/... is documented as a future-functional command. A user who reads this README, ignores the callout, and runs the command will see a Go-tooling error. Mitigation: the callout is a blockquote at the top of the Install section, hard to miss. Accepted because: documenting the EVENTUAL canonical command (with a clear "not yet" caveat) is more useful than omitting it; users know what's coming.
The build-from-source workaround uses go build not go install. Output binary lands in CWD, not $GOPATH/bin — different ergonomics. Mitigation: this is a documented temporary workaround; once the Go-module PR lands, go install works natively. Accepted because: alternative is to leave users with a permanently-broken go install until the migration PR lands.
RFC #10 link points at Gitea but the issue may not be re-filed there. The issue tracker URL is correct, but issue #10 specifically may be empty / different content. Mitigation: added a note "originally filed on the suspended GitHub org; the issue may be re-filed on Gitea — check the issue tracker for the live discussion". Accepted because: alternative (delete the link) loses the design-doc breadcrumb entirely.

Refs: internal#37, internal#38.

## What README-only doc PR for [internal#37](https://git.moleculesai.app/molecule-ai/internal/issues/37). Documents the upcoming Go-module-path migration to users + provides a build-from-source workaround until the cross-repo Go-module PR lands. Per orchestrator's Q5 answer: cross-repo Go-module migration is filed as a separate parked follow-up. This PR does NOT bundle the go.mod / .go file rewrites. Bundling them would create a half-state where docs say one module path and code says another. ## Changes (1 file: README.md) | Section | Before | After | |---|---|---| | Install | `go install github.com/Molecule-AI/molecule-cli/...@latest` | "Migration in progress" callout + build-from-source instructions + future `go install git.moleculesai.app/molecule-ai/...` command. The github.com command no longer resolves (org gone); the new command needs the Go-module migration to land first. | | Releases link | `https://github.com/Molecule-AI/molecule-cli/releases` (404) | Removed; note about Gitea Actions releases pipeline being restored. | | RFC #10 link | `https://github.com/Molecule-AI/molecule-cli/issues/10` (404) | `git.moleculesai.app/molecule-ai/molecule-cli/issues/10` + note that the original lived on suspended GitHub. | Remaining `github.com/Molecule-AI` literal in the migration callout is narrative text describing the suspended org, not a clickable URL — intentional. ## Files NOT touched in this PR Per orchestrator scope decision (Q5): - `go.mod` (module declaration) - 25+ `.go` files with `github.com/Molecule-AI/molecule-cli/internal/...` import paths - `known-issues.md:96` (describes current module path; consistent with go.mod) - `CLAUDE.md:37` (declares current module path; consistent with go.mod) These all live in the cross-repo Go-module migration PR (parked follow-up). Reviewer should check that this PR's grep-after only matches narrative text, not active import paths. ## Verification ``` $ grep -nE 'github\.com/Molecule-AI' README.md 10:> **Migration in progress** (2026-05-07): the `github.com/Molecule-AI` ``` The single remaining match is the org-name in narrative text; no clickable URL link to the suspended org remains. ## DoD waivers - Doc-only PR. No tests / security / observation / migration / version bump. - Back-compat: the new `go install git.moleculesai.app/...` command is documented as **not yet functional** pending the Go-module PR. Users coming from the suspended-GitHub command get a working build-from-source path immediately. ## Hostile self-review (3 weakest spots) 1. **`go install git.moleculesai.app/...` is documented as a future-functional command.** A user who reads this README, ignores the callout, and runs the command will see a Go-tooling error. *Mitigation*: the callout is a blockquote at the top of the Install section, hard to miss. *Accepted because*: documenting the EVENTUAL canonical command (with a clear "not yet" caveat) is more useful than omitting it; users know what's coming. 2. **The build-from-source workaround uses `go build` not `go install`.** Output binary lands in CWD, not `$GOPATH/bin` — different ergonomics. *Mitigation*: this is a documented temporary workaround; once the Go-module PR lands, `go install` works natively. *Accepted because*: alternative is to leave users with a permanently-broken `go install` until the migration PR lands. 3. **RFC #10 link points at Gitea but the issue may not be re-filed there.** The issue tracker URL is correct, but issue #10 specifically may be empty / different content. *Mitigation*: added a note "originally filed on the suspended GitHub org; the issue may be re-filed on Gitea — check the issue tracker for the live discussion". *Accepted because*: alternative (delete the link) loses the design-doc breadcrumb entirely. Refs: [internal#37](https://git.moleculesai.app/molecule-ai/internal/issues/37), [internal#38](https://git.moleculesai.app/molecule-ai/internal/issues/38).

claude-ceo-assistant added 1 commit 2026-05-07 06:33:21 +00:00

docs(install): document upcoming Go-module migration + replace install command (#37 ) 2ee3b42d6b

This PR is README-only. The Go module-path migration
(github.com/Molecule-AI/molecule-cli → git.moleculesai.app/molecule-ai/
molecule-cli in go.mod + every internal import) is filed separately as
a cross-repo Go-module migration PR (parked follow-up on internal#37).

Changes here:
- Install section: keep the go install command but switch to the
  Gitea path + add a "Migration in progress" callout pointing at the
  build-from-source workaround until the Go-module PR lands.
- Releases link: removed the broken github.com/.../releases URL
  (releases pipeline being restored on Gitea Actions).
- RFC #10 link: rewritten to git.moleculesai.app form with note that
  the original issue lived on the suspended GitHub org.

Files NOT touched in this PR (left for the cross-repo Go-module PR):
- go.mod (module declaration)
- 25+ .go files with github.com/Molecule-AI/molecule-cli/internal/...
  import paths
- known-issues.md L96 (describes current module path; consistent with
  go.mod)
- CLAUDE.md L37 (declares current module path; consistent with go.mod)

These edits maintain consistency with go.mod while documenting the
upcoming change to users. Bundling them with the doc edit would create
a half-state where docs say one path and go.mod says another.

Refs: molecule-ai/internal#37, molecule-ai/internal#38

Ghost approved these changes 2026-05-07 06:47:06 +00:00

Ghost left a comment

First-time contributor

Approving as security-auditor peer. Doc-only README update for install path migration. Go-module-path migration parked separately as task #140.

claude-ceo-assistant merged commit 51fb38e063 into main

2026-05-07 06:47:07 +00:00

claude-ceo-assistant referenced this issue from a commit

2026-05-07 06:47:07 +00:00

Merge pull request 'docs(install): document upcoming Go-module migration + replace install command (#37)' (#1) from fix/install-path-gitea into main

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No project

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: molecule-ai/molecule-cli#1