Skip to content

Add "Getting started" guide#10

Merged
alcuadrado merged 28 commits intomainfrom
add-getting-started-guide
May 29, 2025
Merged

Add "Getting started" guide#10
alcuadrado merged 28 commits intomainfrom
add-getting-started-guide

Conversation

@fvictorio
Copy link
Copy Markdown
Contributor

Incomplete draft of the "Getting started" guide.

Pending sections:

  • Using scripts
  • Deploying contracts
  • Next steps

Some things to improve that I've noticed but I haven't worked on yet:

  • Text is still too chatgptish.
  • "This task compiles your Solidity source files and generates the corresponding artifacts" -> This should either explain what artifacts are (before or after), use a different phrasing, or avoid mentioning artifacts altogether.
  • Inconsistent use of plain "Hardhat" vs "Hardhat 3".
  • The term "sub-tasks" is used but not explained. This might be fine; maybe the context is enough.
  • Temporary networks are mentioned but not explained. This might be fine.
  • "Whether you're compiling contracts, running tests, deploying to testnets, or executing custom logic, tasks are the core of how you interact with Hardhat." -> Added by chatgpt; maybe this paragraph can be replaced by a different way to close the section, or just removed.
  • The "Writing tests" introduction might be too detailed.
  • Cheatcodes are mentioned but not explained.
  • Consider updating the example project and this guide so that the fuzz tests is third and after the unit tests, not in the middle of them.

@vercel
Copy link
Copy Markdown

vercel bot commented May 22, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hardhat-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 29, 2025 8:05pm

@fvictorio fvictorio changed the title Add "Getting started" guide draft Add "Getting started" guide May 22, 2025
@alcuadrado alcuadrado force-pushed the add-getting-started-guide branch from 82e605b to a918c8b Compare May 27, 2025 20:06
@alcuadrado alcuadrado changed the base branch from add-using-viem-guide to main May 27, 2025 20:06
@alcuadrado alcuadrado requested a review from Copilot May 28, 2025 20:31
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a draft "Getting started" guide to help users install, configure, and test their Hardhat projects. The guide covers installation steps, project structure, writing smart contracts, and testing with both Solidity and TypeScript, and the directory info has been updated to link to this new guide.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/content/hardhat3-alpha/learn-more/getting-started.md New guide draft covering installation, project structure, smart contract writing, and testing.
src/content/hardhat3-alpha/learn-more/_dirinfo.yaml Updated navigation to include a link to the "Getting started" guide.

Comment thread src/content/hardhat3-alpha/learn-more/getting-started.md Outdated
Comment thread src/content/hardhat3-alpha/learn-more/getting-started.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@alcuadrado alcuadrado marked this pull request as ready for review May 29, 2025 19:41
@alcuadrado alcuadrado requested a review from Copilot May 29, 2025 19:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a draft of the "Getting started" guide with new documentation for deploying contracts using Hardhat Ignition and updates to the navigation structure for the Hardhat 3 Alpha documentation.

  • Added a detailed guide for deploying smart contracts using Hardhat Ignition.
  • Updated directory metadata files (_dirinfo.yaml) to reorganize and include new learning topics.
  • Added a new dependency in package.json for markdown link checking.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

File Description
src/content/hardhat3-alpha/learn-more/deploying-contracts.md Added new documentation for deploying contracts with Hardhat Ignition, including instructions for both temporary and persistent network deployments.
src/content/hardhat3-alpha/learn-more/_dirinfo.yaml Updated the ordering to include the "Deploying contracts" section and rearranged links in the "Learn more" group.
src/content/hardhat3-alpha/_dirinfo.yaml Modified the Hardhat 3 Alpha navigation order to add new sections such as "Get started" and "Writing scripts," which may result in similar naming with existing sections.
package.json Added the "markdown-link-check" dependency to support verifying markdown links.
Comments suppressed due to low confidence (2)

src/content/hardhat3-alpha/learn-more/deploying-contracts.md:3

  • [nitpick] The reference to 'Hardhat 2' in this section might be confusing since the guide targets Hardhat 3. Consider updating the version reference to consistently reflect the intended environment.
+Hardhat comes with an official deployment solution: [**Hardhat Ignition**](https://hardhat.org/ignition), a declarative system for deploying smart contracts...

src/content/hardhat3-alpha/_dirinfo.yaml:4

  • The section title 'Get started' is very similar to the existing 'Getting started' section. Renaming one of them could help avoid confusion among users navigating the documentation.
- title: Get started

@alcuadrado alcuadrado merged commit 67780bd into main May 29, 2025
4 checks passed
@alcuadrado alcuadrado deleted the add-getting-started-guide branch July 1, 2025 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants