Skip to content

docs: add editor setup guide#5553

Merged
alexiscolin merged 47 commits into
gnolang:masterfrom
davd-gzl:docs/editor-setup
May 28, 2026
Merged

docs: add editor setup guide#5553
alexiscolin merged 47 commits into
gnolang:masterfrom
davd-gzl:docs/editor-setup

Conversation

@davd-gzl

@davd-gzl davd-gzl commented Apr 20, 2026

Copy link
Copy Markdown
Member

@davd-gzl davd-gzl marked this pull request as draft April 20, 2026 10:45
@github-actions github-actions Bot added 📖 documentation Improvements or additions to documentation 📄 top-level-md labels Apr 20, 2026
@Gno2D2

Gno2D2 commented Apr 20, 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
    │       ├── 🟢 User notJoon already reviewed PR 5553 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

@codecov

codecov Bot commented Apr 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@davd-gzl davd-gzl marked this pull request as ready for review April 23, 2026 10:06
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Apr 23, 2026
@davd-gzl davd-gzl added the a/ux User experience, product, marketing community, developer experience team label Apr 23, 2026

@notJoon notJoon 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 👍

also related to: gnoverse/gnopls#39

@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Apr 24, 2026

@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.

Since you worked on this, I'd love to get your opinion on this @gfanton.
The plugin list looks accurate and the structure is clean, but the page is missing the "show me, don't tell me" pieces that editor-setup guides typically lean on like:

  • Screenshots of a working LSP. This is the biggest gap. A user finishes the setup with no way to know if it worked: autocomplete popup, hover info, diagnostics underline are all
    invisible from a CLI. Even one screenshot per officially supported editor changes the page.
  • A concrete "did it work?" check. gnopls version only proves the binary runs. Add a stepwise check: "open a .gno file, type pri you should see println suggested". Same idea as a smoke test in install docs.
  • The gnodev save-loop. Save .gno → gnodev hot-reloads → result in the browser is the killer Gno workflow. It also belongs in an editor-setup guide: at minimum a mention with a pointer?

These are additive, the page looks nice today, but each item beyond the screenshots gives a noticeable conversion lift on the "I want to be productive in 10 minutes" path no ?

Comment thread docs/resources/editor-setup.md Outdated
Comment thread docs/resources/editor-setup.md Outdated
davd-gzl added a commit to davd-gzl/gno that referenced this pull request May 5, 2026
Address review feedback on gnolang#5553: replace the gno fmt/lint CLI snippet
with a "Verify your setup" section (completion, hover, diagnostics
checks) so users can confirm the editor is actually wired to gnopls,
not just that the binary runs.
@davd-gzl

davd-gzl commented May 5, 2026

Copy link
Copy Markdown
Member Author

I've updated to add some of the propositions.
I've not yet added screenshot / visual clue (same for other documentation: getting started, cheatsheet, ...), and it should be added in a next work / this PR.

I added a next step for auto save + gnodev mention.

@moul

moul commented May 12, 2026

Copy link
Copy Markdown
Member

This PR competes with the README of gnopls: https://github.com/gnoverse/gnopls.

I prefer to keep only gnopls' README as the main source of truth and reference the gnoverse repository from here.

@davd-gzl

davd-gzl commented May 12, 2026

Copy link
Copy Markdown
Member Author

Per #5651 and #5553 (comment), I think we should close that PR and add a reference to gnopls documentation in #5552

Except if we make it step by step (as a comprehensive tutorial, which is not the current scope), this work don't add any real value.

If missing information, I will update gnopls documentation in a next work.

@davd-gzl davd-gzl closed this May 12, 2026
davd-gzl added a commit to davd-gzl/gno that referenced this pull request May 12, 2026
Add a top-of-page pointer ("For IDE / LSP support, see Editor setup")
and a Next-steps entry, both linking to docs/builders/editor-setup.md.
That doc will land in a separate PR (gnolang#5553, slimmed); the links will
404 until then.
@davd-gzl

davd-gzl commented May 12, 2026

Copy link
Copy Markdown
Member Author

After deeper thinking, it's better in my opinion to separate "installation" and "editor setup" in two documents as they have different utilities, but limit the strict necessary and official to this document, while the community and detailed setup to gnopls README.

davd-gzl@aa464e8

The new rewrite shouldn't compete anymore with the gnopls README.

@davd-gzl davd-gzl force-pushed the docs/editor-setup branch from 01d038b to cef4bfe Compare May 18, 2026 15:26
@davd-gzl davd-gzl removed 📦 🤖 gnovm Issues or PRs gnovm related 🛠️ gnodev labels May 18, 2026
Comment thread docs/builders/install.md Outdated
Comment thread docs/builders/install.md Outdated
Comment thread CONTRIBUTING.md Outdated
davd-gzl and others added 3 commits May 19, 2026 10:52
Co-authored-by: Jeff Thompson <jeff@berty.tech>
Co-authored-by: Jeff Thompson <jeff@berty.tech>
Co-authored-by: Jeff Thompson <jeff@berty.tech>
@davd-gzl davd-gzl requested a review from jefft0 May 19, 2026 08:53
Comment thread misc/docs/sidebar.json Outdated
@davd-gzl davd-gzl requested a review from alexiscolin May 20, 2026 16:01
davd-gzl added a commit to davd-gzl/gno that referenced this pull request May 20, 2026
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) and cheatsheet (gnolang#5551) — drop their
  individual PRs once this lands.
- Cross-links updated across docs/, README.md, and misc/deployments/.
davd-gzl added a commit to davd-gzl/gno that referenced this pull request May 21, 2026
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/.
@alexiscolin alexiscolin removed the request for review from jefft0 May 28, 2026 17:26
@alexiscolin alexiscolin merged commit 7922f54 into gnolang:master May 28, 2026
82 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a/ux User experience, product, marketing community, developer experience team 📖 documentation Improvements or additions to documentation 📄 top-level-md

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

7 participants