Skip to content

docs(builders): consolidate and clean up builder documentation#5656

Merged
alexiscolin merged 20 commits into
gnolang:masterfrom
davd-gzl:david/all-doc-prs
Jun 24, 2026
Merged

docs(builders): consolidate and clean up builder documentation#5656
alexiscolin merged 20 commits into
gnolang:masterfrom
davd-gzl:david/all-doc-prs

Conversation

@davd-gzl

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

Copy link
Copy Markdown
Member

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.mdresources/gnodev.md, rewritten as a reference (features + flags, no longer a Counter walkthrough).
  • example-minisocial-dapp.mdtutorial-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-gnolangwhat-is-gno, quick-startquickstart, connect-clients-and-appsrpc-clients, become-a-gnomecontributor-guide. H1 titles aligned with new filenames.
  • Preserved unique content: package-type import matrix → resources/gno-packages.md; pointers from getting-started.mdgas-fees.md (out-of-gas troubleshooting), storage-deposit.md (-max-deposit).
  • Renamed the default gnodev key test1devtest 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.

@Gno2D2

Gno2D2 commented May 12, 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)
  • Determine if infra needs to be updated before merging
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
Determine if infra needs to be updated before merging

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Or
        ├── 🔴 A changed file matches this pattern: Dockerfile
        ├── 🟢 A changed file matches this pattern: ^misc/deployments (filename: misc/deployments/home-alias/home.default.md)
        ├── 🔴 A changed file matches this pattern: ^misc/docker-
        └── 🔴 A changed file matches this pattern: ^.github/workflows/release.*\.yml$

Can be checked by

  • team devops

@codecov

codecov Bot commented May 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions github-actions Bot added 🛠️ gnodev 📦 🤖 gnovm Issues or PRs gnovm related labels May 14, 2026
@davd-gzl davd-gzl marked this pull request as ready for review May 15, 2026 15:47
@davd-gzl davd-gzl requested a review from alexiscolin May 15, 2026 15:47
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label May 15, 2026
alexiscolin added a commit that referenced this pull request May 20, 2026
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>
@davd-gzl davd-gzl force-pushed the david/all-doc-prs branch from 64b7362 to 2ea635a Compare May 20, 2026 16:53
davd-gzl added 2 commits May 21, 2026 18:44
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
…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.
davd-gzl added 5 commits June 1, 2026 00:27
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.
thehowl pushed a commit to gnolang/docs.gno.land that referenced this pull request Jun 4, 2026
* 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.
@alexiscolin

Copy link
Copy Markdown
Member

@davd-gzl Can you resolve the conflicts and let me know when it's ready to merge? I'll take care of it. 👍

@davd-gzl davd-gzl requested a review from alexiscolin June 5, 2026 10:41
@davd-gzl

davd-gzl commented Jun 5, 2026

Copy link
Copy Markdown
Member Author

(still need to fix the CI)
fix: 84a40b9

davd-gzl and others added 2 commits June 5, 2026 12:50
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 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.

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.
@github-actions github-actions Bot added the 🧾 package/realm Tag used for new Realms or Packages. label Jun 8, 2026
@davd-gzl

davd-gzl commented Jun 8, 2026

Copy link
Copy Markdown
Member Author

Good catch, fix: 0bbcb61
@alexiscolin

@alexiscolin

Copy link
Copy Markdown
Member

@davd-gzl Here is the actual homepage at the moment. :) https://github.com/gnolang/gno/blob/master/misc/deployments/home-alias/home.default.md

@davd-gzl

davd-gzl commented Jun 8, 2026

Copy link
Copy Markdown
Member Author

@alexiscolin Sorry I misunderstood, though it was already patched in earlier commit:

- [Efficient local development for Gno](https://docs.gno.land/resources/gnodev)

… 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.
@alexiscolin alexiscolin merged commit 1822034 into gnolang:master Jun 24, 2026
100 of 101 checks passed
thehowl added a commit to mvallenet/gno that referenced this pull request Jul 8, 2026
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.
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 🐳 devops 🛠️ gnodev 🧾 package/realm Tag used for new Realms or Packages. 📄 top-level-md

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

4 participants