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.

Sign up for GitHub

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

Jump to bottom

Add OPL tutorial #423

Merged
merged 23 commits into from
Jun 7, 2023
Merged

Add OPL tutorial #423

merged 23 commits into from
Jun 7, 2023

Conversation

aefhm
Copy link
Contributor

@aefhm aefhm commented Apr 21, 2023 •
edited
Loading

Description

Add Tutorial per https://app.clickup.com/t/863g6zgyg

TODO

  • Add OPL diagram from presentation
  • Add testnet deployment steps
  • Add faucet steps
  • Elaborate what “Host” and “Enclave” mean
  • Simplify repo more
  • Add screenshots of the application/UI
  • Highlight private variable
  • Resize screenshots
  • Improve sparse checkout
  • Agree on Oasis Privacy Layer vs Oasis privacy layer casing

@netlify
Copy link

netlify bot commented Apr 21, 2023 •
edited
Loading

✅ Deploy Preview for trusting-archimedes-14c863 ready!

Name Link
🔨 Latest commit d4dc2c6
🔍 Latest deploy log https://app.netlify.com/sites/trusting-archimedes-14c863/deploys/64807c7409ff0e0008315f9f
😎 Deploy Preview https://deploy-preview-423--trusting-archimedes-14c863.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@aefhm aefhm self-assigned this Apr 21, 2023
@aefhm aefhm force-pushed the xz/add-secret-ballot branch 2 times, most recently from c4b0d66 to c4e9f05 Compare April 23, 2023 21:10
@aefhm aefhm added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Apr 23, 2023
@aefhm aefhm force-pushed the xz/add-secret-ballot branch 2 times, most recently from 315e26c to 821f3a3 Compare April 23, 2023 23:13
@aefhm aefhm marked this pull request as ready for review April 23, 2023 23:13
@aefhm
Copy link
Contributor Author

aefhm commented Apr 25, 2023

Consider moving under Sapphire section.

matevz
matevz requested changes May 12, 2023
View reviewed changes
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

Also, please resize the screenshots to full-hd width (1920px x ...)

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/dapp/opl/README.md Outdated Show resolved Hide resolved
docs/dapp/opl/README.md Show resolved Hide resolved
sidebarDapp.js Outdated Show resolved Hide resolved
docs/dapp/opl/enclave.md Show resolved Hide resolved
docs/dapp/opl/enclave.md Outdated Show resolved Hide resolved
docs/dapp/opl/build.md Outdated Show resolved Hide resolved
docs/dapp/opl/build.md Outdated Show resolved Hide resolved
docs/dapp/opl/build.md Show resolved Hide resolved
matevz
matevz reviewed May 12, 2023
View reviewed changes
docs/dapp/opl/build.md Outdated Show resolved Hide resolved
@aefhm aefhm force-pushed the xz/add-secret-ballot branch 2 times, most recently from 3a35791 to db1c49b Compare May 15, 2023 06:42
matevz
matevz requested changes May 19, 2023
View reviewed changes
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

Second pass. I got stuck in the frontend example since the pnpm workspaces weren't configured. I would add those in the beginning.

docs/dapp/opl/host.md Outdated Show resolved Hide resolved
docs/dapp/opl/host.md Outdated Show resolved Hide resolved
docs/dapp/opl/host.md Outdated Show resolved Hide resolved
docs/dapp/opl/host.md Outdated Show resolved Hide resolved
docs/dapp/opl/host.md Outdated Show resolved Hide resolved
docs/dapp/opl/frontend.md Show resolved Hide resolved
docs/dapp/opl/frontend.md Outdated Show resolved Hide resolved
docs/dapp/opl/frontend.md Outdated Show resolved Hide resolved
docs/dapp/opl/frontend.md Outdated Show resolved Hide resolved
docs/dapp/opl/frontend.md Outdated Show resolved Hide resolved
@matevz matevz mentioned this pull request May 26, 2023
Merged
aefhm and others added 3 commits June 6, 2023 00:48
@aefhm
Improve README
785704d
@aefhm @matevz
Apply suggestions from code review
e87ab29 
Co-authored-by: Matevž Jekovec <matevz@oasisprotocol.org>
@aefhm
Update example admonition
871d5d5
aefhm and others added 15 commits June 6, 2023 01:10
@aefhm
Improve setup
975ab45
@aefhm @matevz
Apply suggestions from code review
dcfd368 
Co-authored-by: Matevž Jekovec <matevz@oasisprotocol.org>
@aefhm @matevz
Fix Testnet casing
c4bb84e 
Co-authored-by: Matevž Jekovec <matevz@oasisprotocol.org>
@aefhm
Improve build instructions
a2f4cb9
@aefhm @matevz
Update docs/dapp/opl/build.md
621596f 
Co-authored-by: Matevž Jekovec <matevz@oasisprotocol.org>
@aefhm @matevz
Update docs/dapp/opl/build.md
57c002b 
Co-authored-by: Matevž Jekovec <matevz@oasisprotocol.org>
@aefhm
Improve host instructions
b2a1704
@aefhm
Improve enclave instructions
7783aa9
@aefhm
Improve frontend instructions
81ac423
@aefhm
Improve build instructions
812fec9
@aefhm
Improve host instructions
d067680
@aefhm
Improve frontend token documentation
e356118
@aefhm
Improve frontend documentation
e3ebf2f
@aefhm
Fix sparse checkout reference
c571b88
@matevz
opl: Revamp Dapp sidebar and overview, add playground links
d4dc2c6
matevz
matevz approved these changes Jun 7, 2023
View reviewed changes
Copy link
Member

@matevz matevz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Good job.

TODO: Resize screenshots, sparse checkout in OPL tutorial. We'll do this in a separate PR.

@matevz matevz enabled auto-merge June 7, 2023 12:50
@matevz matevz merged commit 71cbcfd into main Jun 7, 2023
@matevz matevz deleted the xz/add-secret-ballot branch June 7, 2023 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matevz matevz matevz approved these changes

@peterjgilbert peterjgilbert Awaiting requested review from peterjgilbert

Assignees

@aefhm aefhm

Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aefhm @matevz