docs: add getting started (alternative to #5519) - #5592
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
|
|
👍 Architecture LGTM. The funnel layering (Try first → TL;DR → Install → Build → Deploy) and the satellite split (#5551, #5552, #5553) is a good pattern. A few UX points from #5519 that I think are worth carrying over before this lands, mostly newcomer-checkpoint stuff:
I'll close #5519 as soon as this one comes out of DRAFT. It might also be interesting to explore how to write for AI browsing (GEO) BTW (to keep in mind) |
|
You should mention your three other documents related to the PR, as they need to be merged to make sense. Otherwise, we will lose valuable knowledge. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
To answer #5592 (comment):
I think overall style can still be improved (some part don't looks very human friendly), but I'm open for first reviews @alexiscolin About GEO I will do a deeper tour. |
50ccf67 to
255d4a6
Compare
alexiscolin
left a comment
There was a problem hiding this comment.
This is the strongest narrative onboarding doc the repo has had, and the dual-page structure (long-form getting-started + commands-only quickstart) is the right structural choice for UX-4 (#5462). Before merge, six blockers: four break the copy-paste promise, two make the contribution invisible/incoherent in production
- README: add Getting started + Quick Start to Build index, reorder so they lead the section; intro now points to Installation for non-default paths. - sidebar.json: regenerated; new pages no longer orphans. - getting-started: align counter signature with canonical r/demo/counter (no n int arg); swap "Create a key" before "Run a local chain" so the auto-funded keybase claim is true for alice; drop the broken local r/docs reference (precompiled binary bakes _GNOROOT=/gnoroot, examples don't load on the install.sh path); align PATH hint with install.md; wrap --version <tag> in backticks for the linter. - quickstart: align embedded counter with canonical signature; drop CLA warning (enforcement disabled in r/sys/cla); replace fragile autolink with a bold code span.
- Move docs/getting-started.md to docs/builders/getting-started.md - Replace `gno init` (unmerged) with `gno mod init` - Tighten copy across TL;DR, Build, Next steps, Troubleshooting - Annotate every code block with a short purpose comment - Link out to docs/troubleshooting.md (separate PR) for the full list
Co-authored-by: Alexis Colin <alexis@jaunebleu.co>
Co-authored-by: Alexis Colin <alexis@jaunebleu.co>
Co-authored-by: Alexis Colin <alexis@jaunebleu.co>
- README: add Getting started + Quick Start to Build index, reorder so they lead the section; intro now points to Installation for non-default paths. - sidebar.json: regenerated; new pages no longer orphans. - getting-started: align counter signature with canonical r/demo/counter (no n int arg); swap "Create a key" before "Run a local chain" so the auto-funded keybase claim is true for alice; drop the broken local r/docs reference (precompiled binary bakes _GNOROOT=/gnoroot, examples don't load on the install.sh path); align PATH hint with install.md; wrap --version <tag> in backticks for the linter. - quickstart: align embedded counter with canonical signature; drop CLA warning (enforcement disabled in r/sys/cla); replace fragile autolink with a bold code span.
- getting-started: split the testnet -remote URL across two code spans with a zero-width space so xurls.Strict can't extract `https://rpc` from the `<testN>` placeholder; keeps the placeholder rendered. - Both files: point `r/docs` at staging.gno.land — gnoweb returns 404 even when rendering on mainnet paths, so the linter rejects them; staging.gno.land is whitelisted and serves the same realm.
0721d1a to
54b803d
Compare
|
I removed the dependency to |
|
Last factual cleanup before merge: CLA enforcement is disabled on all networks today. Reader hits this section, can't tell whether to expect the error. One-line |
|
Should we put something like : ?? |
alexiscolin
left a comment
There was a problem hiding this comment.
Last factual cleanup before merge: CLA enforcement is disabled on all networks today. Reader hits this section, can't tell whether to expect the error. One-line :::info keeps the doc accurate without removing the section (so when CLA reactivates, the rest stays useful). See above
|
Good idea @alexiscolin , fix: 8a96d09 + 294057e |
Changes can be seen at: https://github.com/gnolang/gno/pull/5553/changes/0721d1a56c82bd9990150fe55353f1c8bb8408bd..01d038b35ae95533873b58a6e49e54412a43a24a Depends on (must be merged before): - #5592 (editor setup page linked from this guide) --------- Co-authored-by: Alexis Colin <alexis@jaunebleu.co> Co-authored-by: Jeff Thompson <jeff@berty.tech>
Simple getting started documentation + quickstart to install and bootstrap a local environment, to the creation of a transaction on chain.
There's duplicate content from other documentation, I clean them in a follow-up -> #5656
Alternative to #5519