Skip to content

docs(getting-started): fix accuracy and tighten prose #5755

Merged
alexiscolin merged 3 commits into
gnolang:masterfrom
davd-gzl:docs/upgrade-getting-started
Jun 5, 2026
Merged

docs(getting-started): fix accuracy and tighten prose #5755
alexiscolin merged 3 commits into
gnolang:masterfrom
davd-gzl:docs/upgrade-getting-started

Conversation

@davd-gzl

@davd-gzl davd-gzl commented May 30, 2026

Copy link
Copy Markdown
Member

Follow-up to #5746 to remove awkward phrasing and factual mistakes.

  • correct stdlib/import, installer, crossing-function, Render, linter, and namespace claims against the actual codebase
  • rename "Run locally with gnodev" to "Build and run locally" and number both tutorial sections
  • restructure intro and section openers; replace em-dashes with plain punctuation
  • install.md: gnodev version -> gnodev --help (no such subcommand)

@Gno2D2

Gno2D2 commented May 30, 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

Follow-up to gnolang#5746 to remove awkward phrasing and factual mistakes.

- correct stdlib/import, installer, crossing-function, Render, linter,
  and namespace claims against the actual codebase
- rename "Run locally with gnodev" to "Build and run locally" and number
  both tutorial sections
- show the generated gnomod.toml, give each command a lead-in, smooth
  the intro and section openers, and replace em-dashes with plain
  punctuation
- install.md: gnodev version -> gnodev --help (no such subcommand)
@davd-gzl davd-gzl force-pushed the docs/upgrade-getting-started branch from 702e585 to 422a1ad Compare May 30, 2026 21:57
@davd-gzl davd-gzl marked this pull request as ready for review May 30, 2026 21:57
@davd-gzl davd-gzl requested a review from alexiscolin May 30, 2026 21:57
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 30, 2026
Shorten the getting-started page H1 to 'Getting started' (the docs site uses the H1 as the sidebar label), and reorder the Build on Gno.land index so the sidebar reads What is Gno -> Installation -> Getting started -> Quick Start. Regenerate sidebar.json to match.

@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 on the substance. The factual fixes are exactly the kind of catches that matter for newcomers (gnodev version--help, the Increment(cross(cur)) framing, the gno-interrealm-v2 link, removing "dead code" from the lint description). Numbered steps in the tutorial are a clear UX win and align with the convention used by most onboarding docs out there. "Build and run locally" captures what the section actually does better than the old title. +1 on dropping em-dashes for plainer punctuation: easier for non-native readers, and has become a noisy LLM tell anyway.

Comment thread docs/builders/getting-started.md
@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 31, 2026
@davd-gzl davd-gzl requested a review from jeronimoalbi June 1, 2026 15:29
@codecov

codecov Bot commented Jun 5, 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 merged commit 4c9de52 into gnolang:master Jun 5, 2026
82 checks passed
alexiscolin added a commit that referenced this pull request Jun 24, 2026
Depends on: #5755

Reduces `docs/builders/` from 11 to 8 files, renames the rest for
clarity, and cleans up the bits that got stale or broken in the process.

- Removed `anatomy-of-a-gno-package.md` and `deploy-packages.md` —
content already lived in `getting-started.md` or other reference pages.
- `local-dev-with-gnodev.md` → `resources/gnodev.md`, rewritten as a
reference (features + flags, no longer a Counter walkthrough).
- `example-minisocial-dapp.md` → `tutorial-minisocial.md`, tightened
throughout: condensed the setup steps into a single block, replaced
regex-sliced embedmd snippets with full files for clarity, dropped the
redundant `gnodev` startup walkthrough in favour of a link, and fixed a
broken sentence introducing `posts.gno`.
- `resources/gno-testing.md` rewritten from tutorial to reference (drops
the duplicated Counter setup, fixes broken install link, renames
sections to match `gno test` / `gno run`).
- Renames: `what-is-gnolang` → `what-is-gno`, `quick-start` →
`quickstart`, `connect-clients-and-apps` → `rpc-clients`,
`become-a-gnome` → `contributor-guide`. H1 titles aligned with new
filenames.
- Preserved unique content: package-type import matrix →
`resources/gno-packages.md`; pointers from `getting-started.md` →
`gas-fees.md` (out-of-gas troubleshooting), `storage-deposit.md`
(`-max-deposit`).
- Renamed the default gnodev key `test1` → `devtest` everywhere (matches
the cheatsheet and gnodev's actual default).
- Fixed broken auto-link in `quickstart.md`, broken `[Docs]` reference
in tutorial-minisocial, and the stale `anatomy-of-a-gno-package.md` link
in `gnoland-whitepaper.tex`.
- Cross-links updated across `docs/`, `README.md`, and
`misc/deployments/`.

Includes earlier in-flight docs work merged into this branch.

---------

Co-authored-by: alexiscolin <alexis@jaunebleu.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📖 documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

3 participants