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

Smart Contracts: expand overview page #1080

Merged

Conversation

OlofBlomqvist
Copy link
Contributor

Checklist

  • I have read the How to Contribute.
  • I have run yarn build after adding my changes without getting any errors.

Updating documentation or Bugfix

The current overview page contains more than a few logical & technical errors, and it also does not seem to be written with developers as the intended target audience. At least for me, it was of little use when I got started with Cardano.

In this PR I try to make the overview more useful as a general introduction for developers getting started on Cardano, without going in to too much detail

Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

Really great content here. I still don't work with smart contracts so this has been a real pleasure to read. Only needed some touch up edits mainly for use of English possessive (-s vs. -'s) and I offset some italicised notes as styled admonitions.

(p.s. words spelled 2 different acceptable ways, like utxo's and utxos, I generally left alone unless spelled 2 different ways in the same sentence)

Will double check now in local build to be sure all still looks good. Looking forward to signing off on this as soon as you are happy taking it out of Draft review state.

@rphair rphair changed the title Add smart-contract overview Smart Contracts: expand overview page Jun 7, 2023
@rphair
Copy link
Collaborator

rphair commented Jun 7, 2023

Note @OlofBlomqvist GitHub is being slow to connect my edits in your branch to this PR. Here is the latest change (OlofBlomqvist@01c2ec4) which I'm still waiting more than 15 minutes to show up in the rendered document & in the diff. Hope my editing this way has been helpful for you (I'm done for now unless you put in more sections of text). Thanks again for the brilliant content 🤓

@OlofBlomqvist
Copy link
Contributor Author

Note @OlofBlomqvist GitHub is being slow to connect my edits in your branch to this PR. Here is the latest change (OlofBlomqvist@01c2ec4) which I'm still waiting more than 15 minutes to show up in the rendered document & in the diff. Hope my editing this way has been helpful for you (I'm done for now unless you put in more sections of text). Thanks again for the brilliant content 🤓

Much appreciated, thanks! :)

@OlofBlomqvist OlofBlomqvist marked this pull request as ready for review June 7, 2023 17:11
@rphair
Copy link
Collaborator

rphair commented Jun 7, 2023

My commit still not merged with this branch after 35 minutes; so perhaps best to wait for further review until GitHub problem is fixed (my own review was based on content in my local branch): https://www.githubstatus.com

Investigating - We are investigating reports of degraded availability for Pull Requests.
Jun 07, 2023 - 16:45 UTC

@rphair rphair added the documentation Improvements or additions to documentation label Jun 7, 2023
@rphair
Copy link
Collaborator

rphair commented Jun 7, 2023

should be OK to review now, along with the rest of GitHub...

This incident has been resolved. - Jun 7, 18:39 UTC

@rphair rphair merged commit 51ce5bf into cardano-foundation:staging Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants