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

[website/docs]: add open auction tutorial #930

Merged
merged 11 commits into from
Sep 29, 2023
Merged

[website/docs]: add open auction tutorial #930

merged 11 commits into from
Sep 29, 2023

Conversation

jmcook1186
Copy link
Contributor

Adds new tutorial, borrowing from the example contracts in the Fe Github.

Implements an open auction contract and uses it as a vehicle to explain some foundational Fe concepts.
Also includes brief build & deploy instructions.

Signed-off-by: jmc <jmcook1186@gmail.com>
Signed-off-by: jmc <33655003+jmcook1186@users.noreply.github.com>
Signed-off-by: jmc <33655003+jmcook1186@users.noreply.github.com>
@cburgdorf
Copy link
Collaborator

Just wanted to add that I love to see this guide coming together! ❤️ Just needs a bit of tuning but it's very nice!

@cburgdorf
Copy link
Collaborator

Ah, one more thing: For substantial changes to the docs like this one you should also add a news fragment so that it gets mentioned in the next release notes (which are automated). Basically create a new file here: https://github.com/ethereum/fe/tree/master/newsfragments

It should be named 930.doc.md with the content being roughly something like this:

Added a new tutorial: Open Auction

Signed-off-by: jmc <33655003+jmcook1186@users.noreply.github.com>
Signed-off-by: jmc <33655003+jmcook1186@users.noreply.github.com>
Signed-off-by: jmc <33655003+jmcook1186@users.noreply.github.com>
Signed-off-by: jmc <33655003+jmcook1186@users.noreply.github.com>

When you have implemented all this, your contract should look like this:

```rust
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a reason that this can not use the fe formatting and hence benefit from CI checks? Looks pretty self contained to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no - tbh i nuked them all in favour of ``rust because some were upsetting the linter, but now I see I can run validate_doc_examples.py locally to audit the snippets.

Copy link
Collaborator

@cburgdorf cburgdorf left a comment

Choose a reason for hiding this comment

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

I like this a lot! I just spotted a few more nitpicks. It can go live when those are fixed.

@cburgdorf cburgdorf merged commit 0e6aec3 into ethereum:master Sep 29, 2023
7 checks 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.

2 participants