docs(getting-started): fix accuracy and tighten prose #5755
Conversation
🛠 PR Checks SummaryAll Automated Checks passed. ✅ Manual Checks (for Reviewers):
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) ☑️ Contributor Actions:
☑️ Reviewer Actions:
📚 Resources:Debug
|
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)
702e585 to
422a1ad
Compare
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
left a comment
There was a problem hiding this comment.
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.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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>
Follow-up to #5746 to remove awkward phrasing and factual mistakes.