Skip to content

docs: add dedicated installation page - #5552

Merged
alexiscolin merged 23 commits into
gnolang:masterfrom
davd-gzl:docs/add-installation-page
May 14, 2026
Merged

docs: add dedicated installation page#5552
alexiscolin merged 23 commits into
gnolang:masterfrom
davd-gzl:docs/add-installation-page

Conversation

@davd-gzl

@davd-gzl davd-gzl commented Apr 20, 2026

Copy link
Copy Markdown
Member

Centralize install instructions into docs/builders/installation.md with sections for the one-line binary installer, building from source, and Docker. Replace inline install blocks in local-dev-with-gnodev.md and interact-with-gnokey.md with links to the new page.

Related #5460: #5519 (comment)

Depends on: #5492

Centralize install instructions into docs/builders/installation.md with
sections for the one-line binary installer, building from source, and
Docker. Replace inline install blocks in local-dev-with-gnodev.md and
interact-with-gnokey.md with links to the new page. Add sidebar entry.

Assisted-By: OpenCode (claude-opus-4.6)
@davd-gzl
davd-gzl marked this pull request as draft April 20, 2026 10:43
@github-actions github-actions Bot added the 📖 documentation Improvements or additions to documentation label Apr 20, 2026
@Gno2D2

Gno2D2 commented Apr 20, 2026

Copy link
Copy Markdown
Collaborator

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: davd-gzl/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🔴 At least one of these user(s) reviewed the pull request: [aronpark1007 davd-gzl jefft0 notJoon omarsy MikaelVallenet] (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

@davd-gzl davd-gzl added the a/ux User experience, product, marketing community, developer experience team label Apr 23, 2026
Comment thread docs/builders/install.md Outdated
@davd-gzl
davd-gzl marked this pull request as ready for review April 23, 2026 20:56
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Apr 23, 2026
@codecov

codecov Bot commented Apr 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@alexiscolin alexiscolin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM cc @aeddi / @sw360cab for the ops confirmation

@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Apr 27, 2026
@sw360cab
sw360cab self-requested a review April 27, 2026 08:34

@sw360cab sw360cab left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

davd-gzl added a commit to davd-gzl/gno that referenced this pull request Apr 29, 2026
- Install: link to install.md (PR gnolang#5552), drop TODO comment, SSH→HTTPS
- Drop gno init wizard refs (Create a Realm, Run Script, Call a Function)
- Deploy: pkgpath placeholder <your_g1_address>
- Airgap: -account-number <account-number-from-step-1>
- Update Golden: clarify --update-golden-tests applies to *_filetest.gno
- Use $ADDRESS placeholder for query/airgap address args
- Restructure into Table of Contents + audience sections (User, Developer,
  Valoper, Contributor) with H3 subsections
- Add Valoper section: gnoland secrets, register/update profile, query
- Move Cheatsheet under "Build on Gno.land" in README + regen sidebar.json

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@davd-gzl

davd-gzl commented May 4, 2026

Copy link
Copy Markdown
Member Author

Should add troubleshooting + remove TODO, blocker until added
Edit: fixed in: 3069021, 6fe9d16

davd-gzl added 2 commits May 4, 2026 15:43
One-line installer now invoked with --dir "$(go env GOPATH)/bin" so
binaries land alongside `make install` output, avoiding stale-binary
shadowing on PATH.

Adds Troubleshooting section covering: command not found, stale binary,
macOS Gatekeeper quarantine, Go version too old, GitHub API rate limit.

Removes obsolete TODO comment in Verify section, links GHCR registry,
adds binary-listing step to verify.
- Remove all $HOME/.gno/bin references; doc now consistently points at
  $GOPATH/bin (covers both make install and the one-line installer once
  upstream default is aligned).
- Replace duplicated GOPATH/bin tip block with a pointer to
  Troubleshooting > "command not found".
- Add full-image-list link to GHCR section, drop unverified macOS
  Gatekeeper troubleshooting entry.
- Reorder Next steps to follow the build flow (write -> run -> deploy ->
  interact) and add Deploy packages link.
@aeddi

aeddi commented May 4, 2026

Copy link
Copy Markdown
Contributor

Let's wait for #5492 to be merged so the codegen-verify/docs workflow can do its job.

davd-gzl added 5 commits May 4, 2026 23:59
…l commands

The --version, --full, uninstall, and GITHUB_TOKEN-retry examples were
dropping --dir, so a copy-paste user would get binaries split between
$GOPATH/bin (first command) and the install.sh default. Pass --dir
consistently so every example lands in the directory the verify and
troubleshooting sections already assume.
Add a top-of-page pointer ("For IDE / LSP support, see Editor setup")
and a Next-steps entry, both linking to docs/builders/editor-setup.md.
That doc will land in a separate PR (gnolang#5553, slimmed); the links will
404 until then.
Comment thread docs/builders/install.md
davd-gzl and others added 3 commits May 13, 2026 21:22
Revert the threaded --dir "$(go env GOPATH)/bin" flag from the one-line
installer commands. Use the script's default install path (~/.gno/bin)
throughout the page, and update verify/troubleshooting to match. The
troubleshooting block now covers both the one-line default and the
make-install (GOPATH/bin) case.

Also drop the top-of-page editor-setup pointer; the Next-steps entry is
enough.
Removes the "Editor setup" link from the Next steps list. It'll come
back when the dedicated editor-setup doc lands; until then there's
nothing on disk for the link to point at.
@davd-gzl

davd-gzl commented May 13, 2026

Copy link
Copy Markdown
Member Author

I've changed the install directory according to #5492 (comment) @alexiscolin
This should be merged before #5553

@alexiscolin
alexiscolin merged commit a28468f into gnolang:master May 14, 2026
81 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in 💪 Bounties & Worx May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a/ux User experience, product, marketing community, developer experience team 📖 documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants