Skip to content

docs: add cheat sheet page#5551

Open
davd-gzl wants to merge 10 commits intognolang:masterfrom
davd-gzl:docs/quickstart
Open

docs: add cheat sheet page#5551
davd-gzl wants to merge 10 commits intognolang:masterfrom
davd-gzl:docs/quickstart

Conversation

@davd-gzl
Copy link
Copy Markdown
Member

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

Single copy-paste quickstart covering install, create, test, run locally, query, call, scripting, and deploy.

Related #5460: single "Quick Start" page as first docs page (install → init → edit → deploy, all copy-paste)

Depends on: #5492, #5557, #...

Single copy-paste quickstart covering install, create, test, run locally,
query, call, scripting, and deploy.

Assisted-By: OpenCode (claude-opus-4.6)
@davd-gzl davd-gzl marked this pull request as draft April 20, 2026 10:41
@github-actions github-actions Bot added the 📖 documentation Improvements or additions to documentation label Apr 20, 2026
@Gno2D2
Copy link
Copy Markdown
Collaborator

Gno2D2 commented Apr 20, 2026

🛠 PR Checks Summary

🔴 Must not contain the "don't merge" label
🔴 Pending initial approval by a review team member, or review from tech-staff

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)
🔴 Must not contain the "don't merge" label
🔴 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

Must not contain the "don't merge" label

If

🟢 Condition met
└── 🟢 A label matches this pattern: don't merge (label: don't merge)

Then

🔴 Requirement not satisfied
└── 🔴 On no 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 not 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
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

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

@davd-gzl davd-gzl changed the title docs: add Quick Start page docs: add cheat sheet page Apr 20, 2026
@davd-gzl davd-gzl added the a/ux User experience, product, marketing community, developer experience team label Apr 23, 2026
… wizard

- Rename quickstart.md → cheatsheet.md
- Add categories: Developer & Contributor
- Developer: add airgap transaction, gnokey query auth/accounts, gnodev flags
- Contributor: build/test Go, start a local chain (gnoland start), update golden
  files, lint/format Go
- Reference gno init wizard (gnolang#5557)
- Reference one-line installer (gnolang#5492)
- Add default gnodev test account mnemonic

Assisted-By: OpenCode (claude-opus-4.6)
Comment thread docs/builders/cheatsheet.md
davd-gzl and others added 4 commits April 23, 2026 16:51
Co-authored-by: Jeff Thompson <jeff@berty.tech>
Core loop first: install, create, run locally, key, call (wizard), query.
Advanced topics later: test, format, run script, deploy, airgap.

Assisted-By: OpenCode (claude-opus-4.6)
Core loop first: install, create, run locally, key, call (wizard), query.
Advanced topics later: test, format, run script, deploy, airgap.
Regenerate sidebar.json via make generate.

Assisted-By: OpenCode (claude-opus-4.6)
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@davd-gzl davd-gzl added don't merge Please don't merge this functionality temporarily and removed don't merge Please don't merge this functionality temporarily labels Apr 23, 2026
@davd-gzl davd-gzl marked this pull request as ready for review April 23, 2026 15:25
@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 don't merge Please don't merge this functionality temporarily and removed review/triage-pending PRs opened by external contributors that are waiting for the 1st review labels Apr 23, 2026
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Apr 23, 2026
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 don't merge Please don't merge this functionality temporarily review/triage-pending PRs opened by external contributors that are waiting for the 1st review

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants