Add docs to oz docsite #298

ericnordelo · 2022-11-18T23:20:08Z

No description provided.

ericnordelo · 2022-11-21T12:07:14Z

Hi @frangio! Can you please enable doc site previews through netlify on this PR? I've already configured the repo, I think that's the only thing pending, let me know if there's something else. Thank you.

frangio · 2022-11-22T15:43:37Z

I've added the webhook as described in https://github.com/OpenZeppelin/docs.openzeppelin.com#adding-a-new-repo. Make sure to do the other half of the instructions listed there.

frangio · 2022-11-22T15:46:53Z

Ok I think I've added deploy previews. We need to add a new commit to trigger the build.

ericnordelo · 2022-11-22T15:48:44Z

Ok I think I've added deploy previews. We need to add a new commit to trigger the build.

Thank you! let me check

netlify · 2022-11-22T15:54:20Z

✅ Deploy Preview for silver-paletas-e6cbf6 ready!

Name	Link
🔨 Latest commit	`0487852`
🔍 Latest deploy log	https://app.netlify.com/sites/silver-paletas-e6cbf6/deploys/637cf0aafc5c8800090e32ab
😎 Deploy Preview	https://deploy-preview-298--silver-paletas-e6cbf6.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

…s-to-oz-docsite-#157

ericnordelo · 2022-11-23T18:31:33Z

@andrew-fleming @martriay, I need to add the rest of the commands to CLI and NRE References, but I think it would be good to receive some feedback already from the format and the content of the doc site (and the general refactor).

docs/modules/ROOT/pages/testing.adoc

martriay · 2022-12-28T06:26:29Z

docs/modules/ROOT/pages/api.adoc

@@ -0,0 +1,216 @@
+== API Reference
+
+Here you can find a complete reference of the functions provided by the NileRuntimeEnvironment.


i didn't think the refactor implied huge changes to the docs (afaict interface changes aren't that big), but we can definitely ship without these, and add them later.

martriay

we're almost there!

docs/modules/ROOT/pages/nre.adoc

docs/modules/ROOT/pages/index.adoc

docs/modules/ROOT/pages/scripts.adoc

martriay · 2022-12-28T06:43:39Z

docs/modules/ROOT/pages/scripts.adoc

@@ -18,7 +56,7 @@ async def run(nre):

 NOTE: This script assumes there is an link:https://github.com/OpenZeppelin/nile/tree/main/src/nile/artifacts[Account artifact] in your project. You can add the contract to the contracts folder, and compile with `nile compile` to get the artifact.


just a comment, an alternative thing is to declarer_account.declare("Account", nile_account=True) and it will declare nile's account artifact.

Script updated.

Co-authored-by: Martín Triay <martriay@gmail.com>

…delo/nile into feat/add-docs-to-oz-docsite-#157

martriay

getting there 🚀

martriay · 2022-12-28T23:41:04Z

RELEASING.md


 (4) Create a tag for the release.

 ```sh
-git tag v0.8.0
+git tag v0.12.0


usually there's no need to update this, but no reason against either

docs/modules/ROOT/pages/cli.adoc

martriay · 2022-12-28T23:43:10Z

docs/modules/ROOT/pages/cli.adoc

 +
-Select network: one of ('localhost', 'integration', 'goerli', 'goerli2', 'mainnet').
+Select network: one of (localhost, integration, goerli, goerli2, mainnet).


i'm starting to ask myself whether we should abstract this into its own subsection and link to it, instead of repeating it everywhere

Added snippets to handle these repetitions at least on code, but not sure about moving it into another section and linking, I think if I were going to check a command I would appreciate having the information right there (no extra click for UX).

i like your snippets solution better 👍

martriay · 2022-12-28T23:47:23Z

docs/modules/ROOT/pages/commands.adoc

+* xref:#node[`++node++`]
+* xref:#compile[`++compile++`]
+* xref:#setup[`++setup++`]
+* xref:#declare[`++declare++`]
+* xref:#deploy[`++deploy++`]
+* xref:#call[`++call++`]
+* xref:#send[`++send++`]
+* xref:#counterfactual-address[`++counterfactual-address++`]
+* xref:#status[`++status++`]
+* xref:#debug[`++debug++`]
+* xref:#get-accounts[`++get-accounts++`]
+* xref:#get-nonce[`++get-nonce++`]
+* xref:#get-balance[`++get-balance++`]
+* xref:#run[`++run++`]
+* xref:#clean[`++clean++`]
+* xref:#init[`++init++`]
+* xref:#version[`++version++`]


i wasn't, just pointing out that write operations are the ones that require accounts. i think the grouping is good but not that convinced about the names.

maybe:

transactions ("write" is possibly implied, maybe status ones there too?)

queries

project management

utils

martriay · 2022-12-28T23:49:30Z

docs/modules/ROOT/pages/index.adoc

+
+[,sh]
+----
+(env): pip install cairo-nile


multiple command ones should work as they are. the mac and linux is one an acceptable exception, but the answer for all cases is that it they can be split up:

nile compile

🤖 Compiling all Cairo contracts in the contracts directory 🔨 Compiling contracts/contract.cairo ✅ Done

sudo apt install -y libgmp3-dev # linux

brew install gmp # mac

docs/modules/ROOT/pages/index.adoc

docs/modules/ROOT/pages/plugins.adoc

martriay · 2022-12-28T23:54:31Z

docs/modules/ROOT/pages/scripts.adoc

@@ -13,12 +51,10 @@ Useful if you need to deploy an account in devnet, for previous declaration:
 async def run(nre):
  accounts = await nre.get_accounts(predeployed=True)
  declarer_account = accounts[0]
-  print(await declarer_account.declare("Account"))
+  print(await declarer_account.declare("Account", nile_account=True))


i'd add a small note explaining what nile_account is (it tells nile to use its pre-packed artifacts)

Added a comment in the script.

Co-authored-by: Martín Triay <martriay@gmail.com>

…delo/nile into feat/add-docs-to-oz-docsite-#157

martriay · 2023-01-02T02:15:45Z

docs/modules/ROOT/pages/cli.adoc

+* xref:#init[`++init++`]
+* xref:#node[`++node++`]
+* xref:#compile[`++compile++`]
+* xref:#setup[`++setup++`]


are you sure this shouldn't be in Transactions?

martriay · 2023-01-02T02:19:09Z

docs/modules/ROOT/pages/cli.adoc

 +
-Select network: one of ('localhost', 'integration', 'goerli', 'goerli2', 'mainnet').
+Select network: one of (localhost, integration, goerli, goerli2, mainnet).


i like your snippets solution better 👍

martriay · 2023-01-02T02:21:41Z

docs/modules/ROOT/pages/snippets.adoc

+
+Select network: one of (`localhost`, `integration`, `goerli`, `goerli2`, `mainnet`).
+
+Default to localhost.


Suggested change

Default to localhost.

Default to `localhost`.

martriay · 2023-01-02T02:22:01Z

docs/modules/ROOT/pages/testing.adoc

+(env): python -m pip install nile-coverage
+----
+
+. Use coverage command (from the plugin) to generate a coverage report.


pending comment

ericnordelo · 2023-01-02T12:52:53Z

@martriay @andrew-fleming after the last update approved reviews were staled. Can you approve it again to merge it? Thank you!

ericnordelo added 8 commits November 16, 2022 22:57

feat: add docs folder

b7d3d6a

feat: add netlify for previews

3432f31

feat: add overview description

4c6bcab

feat: add plugins doc file

2f58240

feat: add main structure for docs

4e7430e

feat: add project structure

c48e136

feat: update docs

50e46dd

feat: add more docs

aeee0e4

ericnordelo linked an issue Nov 18, 2022 that may be closed by this pull request

Add Nile docs to OZ docsite #157

Closed

ericnordelo added 3 commits November 21, 2022 22:23

feat: finish quickstart

a4ec11f

feat: add extending nile entry

cab8f07

feat: improve docs

364523c

feat: test deploy previews

0487852

ericnordelo added 10 commits November 22, 2022 17:15

feat: test deploy previews

7781a43

feat: add testing entry

e9012ec

feat: update plugins format

d10563e

refactor: Starknet to StarkNet

8fab7ea

feat: add nre entry

44d872b

feat: add script examples

339452a

Merge branch 'main' of github.com:OpenZeppelin/nile into feat/add-doc…

f847632

…s-to-oz-docsite-#157

feat: improve references

55d5df8

feat: refactor README

66a46d3

fix: typo

45352c2

ericnordelo marked this pull request as ready for review November 23, 2022 18:29

martriay reviewed Dec 28, 2022

View reviewed changes

ericnordelo and others added 12 commits December 28, 2022 16:04

Update docs/modules/ROOT/pages/index.adoc

3bd92f4

Co-authored-by: Martín Triay <martriay@gmail.com>

Update docs/modules/ROOT/pages/nre.adoc

46c961a

Co-authored-by: Martín Triay <martriay@gmail.com>

Update docs/modules/ROOT/pages/testing.adoc

0969834

Co-authored-by: Martín Triay <martriay@gmail.com>

Update docs/modules/ROOT/pages/index.adoc

600347c

Co-authored-by: Martín Triay <martriay@gmail.com>

Update docs/modules/ROOT/pages/index.adoc

ed12376

Co-authored-by: Martín Triay <martriay@gmail.com>

Update docs/modules/ROOT/pages/scripts.adoc

6a12a2d

Co-authored-by: Martín Triay <martriay@gmail.com>

feat: update format

6bc913d

feat: update declare script

4f8042a

Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…

e61876e

…delo/nile into feat/add-docs-to-oz-docsite-#157

fix: typo

8632dfc

refactor: remove single quotes

e4887df

feat: update RELEASING

93c623a

martriay reviewed Dec 28, 2022

View reviewed changes

ericnordelo and others added 6 commits December 29, 2022 01:10

Update docs/modules/ROOT/pages/index.adoc

25d5121

Co-authored-by: Martín Triay <martriay@gmail.com>

Update docs/modules/ROOT/pages/plugins.adoc

4aea1a1

Co-authored-by: Martín Triay <martriay@gmail.com>

feat: remove env

b256998

Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…

f64dd74

…delo/nile into feat/add-docs-to-oz-docsite-#157

feat: add snippets

363422e

feat: group core commands

30a1fe0

martriay previously approved these changes Jan 2, 2023

View reviewed changes

feat: update from reviews

cd54406

ericnordelo dismissed martriay’s stale review via cd54406 January 2, 2023 12:50

frangio mentioned this pull request Jan 2, 2023

Add nile documentation OpenZeppelin/docs.openzeppelin.com#339

Merged

andrew-fleming approved these changes Jan 2, 2023

View reviewed changes

ericnordelo merged commit 56a9037 into OpenZeppelin:main Jan 2, 2023

ericnordelo deleted the feat/add-docs-to-oz-docsite-#157 branch January 2, 2023 22:35

ericnordelo mentioned this pull request Jan 9, 2023

Refactor README.md. #199

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs to oz docsite #298

Add docs to oz docsite #298

ericnordelo commented Nov 18, 2022

ericnordelo commented Nov 21, 2022

frangio commented Nov 22, 2022

frangio commented Nov 22, 2022

ericnordelo commented Nov 22, 2022

netlify bot commented Nov 22, 2022 •

edited

Loading

ericnordelo commented Nov 23, 2022

martriay Dec 28, 2022

martriay left a comment

martriay Dec 28, 2022

ericnordelo Dec 28, 2022

martriay left a comment

martriay Dec 28, 2022

martriay Dec 28, 2022

ericnordelo Dec 29, 2022

martriay Jan 2, 2023

martriay Dec 28, 2022

martriay Dec 28, 2022

martriay Dec 28, 2022

ericnordelo Dec 29, 2022 •

edited

Loading

martriay Jan 2, 2023

martriay Jan 2, 2023

martriay Jan 2, 2023

martriay Jan 2, 2023

ericnordelo commented Jan 2, 2023

		@@ -0,0 +1,216 @@
		== API Reference

		Here you can find a complete reference of the functions provided by the NileRuntimeEnvironment.

		@@ -18,7 +56,7 @@ async def run(nre):

		NOTE: This script assumes there is an link:https://github.com/OpenZeppelin/nile/tree/main/src/nile/artifacts[Account artifact] in your project. You can add the contract to the contracts folder, and compile with `nile compile` to get the artifact.

Add docs to oz docsite #298

Add docs to oz docsite #298

Conversation

ericnordelo commented Nov 18, 2022

ericnordelo commented Nov 21, 2022

frangio commented Nov 22, 2022

frangio commented Nov 22, 2022

ericnordelo commented Nov 22, 2022

netlify bot commented Nov 22, 2022 • edited Loading

✅ Deploy Preview for silver-paletas-e6cbf6 ready!

ericnordelo commented Nov 23, 2022

Choose a reason for hiding this comment

martriay left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

martriay left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericnordelo Dec 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ericnordelo commented Jan 2, 2023

netlify bot commented Nov 22, 2022 •

edited

Loading

ericnordelo Dec 29, 2022 •

edited

Loading