Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: configure contracts page #33

Merged
merged 6 commits into from
Oct 8, 2024

Conversation

mexes20
Copy link
Contributor

@mexes20 mexes20 commented Oct 6, 2024

Task name here

Fixes Issue 21

Types of change

  • doc

@Nadai2010
Copy link
Collaborator

Hi @mexes20, good work, but in this documentation I think a simple guide with images with the steps to follow would be very useful.

We also have to clarify that it will depend on the chain added in scaffold.config.ts, it will access to download a contract in the sepolia or mainnet network (sometimes they will be the same addresses but not always) so we must clarify the chain thing.

@metalboyrick metalboyrick linked an issue Oct 7, 2024 that may be closed by this pull request
@metalboyrick
Copy link
Collaborator

Hi @mexes20, please note that ODHack8 is ending soon! I think you should be good once you resolve @Nadai2010 comments!

@mexes20
Copy link
Contributor Author

mexes20 commented Oct 7, 2024

Hi @mexes20, please note that ODHack8 is ending soon! I think you should be good once you resolve @Nadai2010 comments!

Alright, I'm on it now.

@mexes20
Copy link
Contributor Author

mexes20 commented Oct 7, 2024

@metalboyrick @Nadai2010 Kindly review, I made a couple of Improvements to the doc for more clarity.

Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

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

Apologies I know I said that we're good but I realized theres some changes needed to be done

docs/quick-start/configure-contracts.mdx Outdated Show resolved Hide resolved
static/img/configure_contracts.png Outdated Show resolved Hide resolved
@mexes20 mexes20 requested a review from metalboyrick October 7, 2024 12:33
@mexes20
Copy link
Contributor Author

mexes20 commented Oct 7, 2024

@metalboyrick Kindly review

Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

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

Hi sir, seems you have not addressed Nadai's changes properly.

docs/quick-start/configure-contracts.mdx Outdated Show resolved Hide resolved
docs/quick-start/configure-contracts.mdx Outdated Show resolved Hide resolved
@mexes20
Copy link
Contributor Author

mexes20 commented Oct 8, 2024

scaffold.config.ts

I added an explaination of it in the doc with a sample example just as @Nadai2010 requested. But with the PR I sent now, I've added the scaffold.config.ts for more clarity.

@mexes20
Copy link
Contributor Author

mexes20 commented Oct 8, 2024

@metalboyrick Kindly review, I'm here to make any further changes that may be required, thanks.

@mexes20 mexes20 requested a review from metalboyrick October 8, 2024 11:03
};

const scaffoldConfig = {
targetNetworks: [chains.devnet],
Copy link
Collaborator

Choose a reason for hiding this comment

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

you can just include this part ser, no need to include the entire file, thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay ser

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done ser, kindly review @metalboyrick

@mexes20 mexes20 requested a review from metalboyrick October 8, 2024 11:35
Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

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

Looks good!

@metalboyrick metalboyrick merged commit 7f58d75 into Scaffold-Stark:main Oct 8, 2024
1 check passed
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.

Add documentation for "Configure Contracts" page
3 participants