docs: add editor setup guide#5553
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! |
notJoon
left a comment
There was a problem hiding this comment.
LGTM 👍
also related to: gnoverse/gnopls#39
alexiscolin
left a comment
There was a problem hiding this comment.
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 ?
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.
|
I've updated to add some of the propositions. I added a next step for auto save + gnodev mention. |
|
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. |
|
Per #5651 and #5553 (comment), I think we should close that PR and add a reference to 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 |
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.
|
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 The new rewrite shouldn't compete anymore with the |
01d038b to
cef4bfe
Compare
Co-authored-by: Jeff Thompson <jeff@berty.tech>
Co-authored-by: Jeff Thompson <jeff@berty.tech>
Co-authored-by: Jeff Thompson <jeff@berty.tech>
# Conflicts: # docs/builders/getting-started.md
cf94433 to
ab6a170
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) and cheatsheet (gnolang#5551) — drop their individual PRs once this lands. - Cross-links updated across docs/, README.md, and misc/deployments/.
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/.
Changes can be seen at: https://github.com/gnolang/gno/pull/5553/changes/0721d1a56c82bd9990150fe55353f1c8bb8408bd..01d038b35ae95533873b58a6e49e54412a43a24a
Depends on (must be merged before):