docs(builders): consolidate and clean up builder documentation#5656
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
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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 --------- Co-authored-by: Alexis Colin <alexis@jaunebleu.co>
64b7362 to
2ea635a
Compare
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. - resources/gno-testing.md rewritten from tutorial to reference. - Renames: what-is-gnolang → what-is-gno, connect-clients-and-apps → rpc-clients, become-a-gnome → contributor-guide. H1 titles aligned. - Preserved unique content: package-type import matrix → resources/gno-packages.md; pointers from getting-started.md → gas-fees.md, storage-deposit.md. - Renamed the default gnodev key test1 → devtest everywhere. - Includes editor-setup guide (gnolang#5553) — drop its individual PR once this lands. - Cross-links updated across docs/, README.md, and misc/deployments/.
…nsolidation - Re-target getting-started.md links to the renamed/moved targets (what-is-gno.md, ../resources/gno-packages.md, ../resources/gnodev.md, tutorial-minisocial.md) - Wrap http://localhost:8888 in backticks in resources/gnodev.md so the docs linter does not treat the autolink as a JSX tag
b00a4b2 to
6005266
Compare
…d MyKey placeholder
- Add builders/quickstart to misc/docs/sidebar.json (file exists but was missing from sidebar).
- contribs/gnodev/README: point to docs/resources/gnodev.md (page moved during consolidation).
- tutorial-minisocial: replace {MYKEY} placeholder with MyKey.
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)
Addresses review feedback on gnolang#5656: 'Reference' matches industry convention and the cross-persona nature of the section. Label is generated from the README '##' header; updated the root README anchor accordingly.
… david/all-doc-prs
Match the gno test and gno run examples to the myrealm package used in getting-started, note that gno run works with pure packages and plain non-crossing functions, and update the run example.
Turn the intro's semicolon list into a plain comma list and move the 'much like go test' comparison into the gno test section. Split the remaining semicolons in the gno run and -debug notes into separate sentences.
Describe getting-started as the shortest path from zero to a working local chain and a first on-chain transaction, noting install is included.
* redirects: 301 old builder doc paths changed in gno#5656 The builder docs consolidation in gnolang/gno#5656 deletes three pages and renames five. Their old URLs are indexed and linked externally, so add Netlify 301s to their new homes instead of letting them 404. * redirects: single-hop targets, drop bogus quick-start rule Address review feedback on PR #75: - Add a trailing slash to every redirect 'to' so each hop lands on the canonical URL directly, instead of chaining a second 301 through the site's trailing-slash canonicalization. Covers /resources/gnodev and /builders/getting-started, the two that still lacked it. - Drop /builders/quick-start -> /builders/quickstart: gno#5656 renames no such page and /builders/quick-start never existed in git history, so it documented a rename that never happened. - Document the trailing-slash rationale inline.
|
@davd-gzl Can you resolve the conflicts and let me know when it's ready to merge? I'll take care of it. 👍 |
|
(still need to fix the CI) |
Update links to renamed targets: - what-is-gnolang.md -> what-is-gno.md - anatomy-of-a-gno-package.md -> resources/gno-packages.md - example-minisocial-dapp.md -> tutorial-minisocial.md
alexiscolin
left a comment
There was a problem hiding this comment.
Updating the homepage markdown file and the home realm may prevent a 404 error or redirect.
The builders/local-dev-with-gnodev page moved to resources/gnodev in this branch; update the home realm link and its filetest snapshot so it no longer 404s.
|
Good catch, fix: 0bbcb61 |
|
@davd-gzl Here is the actual homepage at the moment. :) https://github.com/gnolang/gno/blob/master/misc/deployments/home-alias/home.default.md |
|
@alexiscolin Sorry I misunderstood, though it was already patched in earlier commit: |
… updates before deletion Resolve modify/delete conflicts on the two files this PR removes by carrying their master-side updates into the new homes first: - deploy-packages.md (gnolang#5608): add the PKGPATH output line to the maketx addpkg sample in builders/getting-started.md. - local-dev-with-gnodev.md (gnolang#5604, native loader): in resources/gnodev.md, switch the default dev path to gno.land/r/dev/<dirname> (sanitized), describe on-demand examples resolution, and replace the removed -resolver flag with -remote / -extra-root / -no-examples.
query-state-api.md (added on master) linked to connect-clients-and-apps.md, which this branch renamed to rpc-clients.md. Update the link so the docs linter (codegen-verify / docs) passes.
docs/builders/deploy-packages.md was deleted on master by gnolang#5656 (docs consolidation) and came back through a merge; nothing links to it. The naming rule lives in docs/resources/gno-packages.md, now extended to state that the last path element must be shaped like a package name (no hyphens, two+ chars) and that consecutive version suffixes are rejected.
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.anatomy-of-a-gno-package.mdanddeploy-packages.md— content already lived ingetting-started.mdor 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 redundantgnodevstartup walkthrough in favour of a link, and fixed a broken sentence introducingposts.gno.resources/gno-testing.mdrewritten from tutorial to reference (drops the duplicated Counter setup, fixes broken install link, renames sections to matchgno test/gno run).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.resources/gno-packages.md; pointers fromgetting-started.md→gas-fees.md(out-of-gas troubleshooting),storage-deposit.md(-max-deposit).test1→devtesteverywhere (matches the cheatsheet and gnodev's actual default).quickstart.md, broken[Docs]reference in tutorial-minisocial, and the staleanatomy-of-a-gno-package.mdlink ingnoland-whitepaper.tex.docs/,README.md, andmisc/deployments/.Includes earlier in-flight docs work merged into this branch.