Skip to content
This repository has been archived by the owner on Dec 1, 2023. It is now read-only.

Add docs to oz docsite #298

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
91 commits
Select commit Hold shift + click to select a range
b7d3d6a
feat: add docs folder
ericnordelo Nov 16, 2022
3432f31
feat: add netlify for previews
ericnordelo Nov 16, 2022
4c6bcab
feat: add overview description
ericnordelo Nov 17, 2022
2f58240
feat: add plugins doc file
ericnordelo Nov 17, 2022
4e7430e
feat: add main structure for docs
ericnordelo Nov 17, 2022
c48e136
feat: add project structure
ericnordelo Nov 17, 2022
50e46dd
feat: update docs
ericnordelo Nov 18, 2022
aeee0e4
feat: add more docs
ericnordelo Nov 18, 2022
a4ec11f
feat: finish quickstart
ericnordelo Nov 21, 2022
cab8f07
feat: add extending nile entry
ericnordelo Nov 21, 2022
364523c
feat: improve docs
ericnordelo Nov 21, 2022
0487852
feat: test deploy previews
ericnordelo Nov 22, 2022
7781a43
feat: test deploy previews
ericnordelo Nov 22, 2022
e9012ec
feat: add testing entry
ericnordelo Nov 22, 2022
d10563e
feat: update plugins format
ericnordelo Nov 22, 2022
8fab7ea
refactor: Starknet to StarkNet
ericnordelo Nov 22, 2022
44d872b
feat: add nre entry
ericnordelo Nov 22, 2022
339452a
feat: add script examples
ericnordelo Nov 22, 2022
f847632
Merge branch 'main' of github.com:OpenZeppelin/nile into feat/add-doc…
ericnordelo Nov 23, 2022
55d5df8
feat: improve references
ericnordelo Nov 23, 2022
66a46d3
feat: refactor README
ericnordelo Nov 23, 2022
45352c2
fix: typo
ericnordelo Nov 23, 2022
cba7d11
Update docs/modules/ROOT/pages/quickstart.adoc
ericnordelo Nov 24, 2022
5384655
Update docs/modules/ROOT/pages/quickstart.adoc
ericnordelo Nov 24, 2022
aa4dc21
Update docs/modules/ROOT/pages/quickstart.adoc
ericnordelo Nov 24, 2022
6f80bd0
Update docs/modules/ROOT/pages/quickstart.adoc
ericnordelo Nov 24, 2022
a683cc8
Update docs/modules/ROOT/pages/quickstart.adoc
ericnordelo Nov 24, 2022
0ce3355
Update docs/modules/ROOT/pages/testing.adoc
ericnordelo Nov 24, 2022
f084a6d
Update docs/modules/ROOT/pages/strings.adoc
ericnordelo Nov 24, 2022
295a431
Update docs/modules/ROOT/pages/create_plugin.adoc
ericnordelo Nov 24, 2022
85d6111
feat: improve docs
ericnordelo Nov 25, 2022
99724c4
feat: finish commands
ericnordelo Nov 25, 2022
e5a8de7
feat: finish api
ericnordelo Nov 25, 2022
91ea5fb
Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…
ericnordelo Nov 25, 2022
ac152a2
feat: fix from review
ericnordelo Nov 25, 2022
902bdb2
Update docs/modules/ROOT/pages/strings.adoc
ericnordelo Dec 7, 2022
34489bf
Merge branch 'main' of github.com:OpenZeppelin/nile into feat/add-doc…
ericnordelo Dec 7, 2022
927e839
Update docs/modules/ROOT/pages/nre.adoc
ericnordelo Dec 7, 2022
f7b120e
feat: merge Overview and Quickstart
ericnordelo Dec 7, 2022
88ef447
Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…
ericnordelo Dec 7, 2022
9928ea8
feat: update nre
ericnordelo Dec 7, 2022
28dd5f0
feat: update from review suggestions
ericnordelo Dec 7, 2022
6b88b73
feat: update CONTRIBUTING and RELEASING
ericnordelo Dec 7, 2022
060c84f
feat: update README
ericnordelo Dec 7, 2022
c163e31
feat: add installation
ericnordelo Dec 7, 2022
bc5d4da
feat: format
ericnordelo Dec 7, 2022
a79d467
Update docs/modules/ROOT/pages/scripts.adoc
ericnordelo Dec 9, 2022
b92c5bd
feat: add optional args
ericnordelo Dec 9, 2022
542628d
Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…
ericnordelo Dec 9, 2022
e7a7486
feat: improve wording and fix typos
ericnordelo Dec 9, 2022
889a345
Update docs/modules/ROOT/pages/testing.adoc
ericnordelo Dec 27, 2022
6f80ed2
Update docs/modules/ROOT/pages/nre.adoc
ericnordelo Dec 27, 2022
598edbf
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 27, 2022
40a0966
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 27, 2022
2c2ec14
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 27, 2022
b325d3c
Update docs/modules/ROOT/pages/plugins.adoc
ericnordelo Dec 27, 2022
ac04ac8
Update docs/modules/ROOT/pages/strings.adoc
ericnordelo Dec 27, 2022
b8bc72e
Update docs/modules/ROOT/pages/scripts.adoc
ericnordelo Dec 27, 2022
42f18a3
Update docs/modules/ROOT/pages/plugins.adoc
ericnordelo Dec 27, 2022
df4ebcd
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 27, 2022
4c4ea7a
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 27, 2022
100bb84
Update docs/modules/ROOT/pages/commands.adoc
ericnordelo Dec 27, 2022
bc30cf4
Update docs/modules/ROOT/pages/nre.adoc
ericnordelo Dec 27, 2022
91d8c1b
Update docs/antora.yml
ericnordelo Dec 27, 2022
aced25b
refactor: improve ui
ericnordelo Dec 27, 2022
8d3413e
Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…
ericnordelo Dec 27, 2022
a047eae
feat: apply updates from review
ericnordelo Dec 27, 2022
cce2808
fix: linter
ericnordelo Dec 27, 2022
a9a98ac
feat: update paths format
ericnordelo Dec 27, 2022
361fa52
refactor: page organization
ericnordelo Dec 27, 2022
98eb8fc
feat: add more info
ericnordelo Dec 27, 2022
d242004
feat: add interacting with starknet section
ericnordelo Dec 27, 2022
3bd92f4
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 28, 2022
46c961a
Update docs/modules/ROOT/pages/nre.adoc
ericnordelo Dec 28, 2022
0969834
Update docs/modules/ROOT/pages/testing.adoc
ericnordelo Dec 28, 2022
600347c
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 28, 2022
ed12376
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 28, 2022
6a12a2d
Update docs/modules/ROOT/pages/scripts.adoc
ericnordelo Dec 28, 2022
6bc913d
feat: update format
ericnordelo Dec 28, 2022
4f8042a
feat: update declare script
ericnordelo Dec 28, 2022
e61876e
Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…
ericnordelo Dec 28, 2022
8632dfc
fix: typo
ericnordelo Dec 28, 2022
e4887df
refactor: remove single quotes
ericnordelo Dec 28, 2022
93c623a
feat: update RELEASING
ericnordelo Dec 28, 2022
25d5121
Update docs/modules/ROOT/pages/index.adoc
ericnordelo Dec 29, 2022
4aea1a1
Update docs/modules/ROOT/pages/plugins.adoc
ericnordelo Dec 29, 2022
b256998
feat: remove env
ericnordelo Dec 29, 2022
f64dd74
Merge branch 'feat/add-docs-to-oz-docsite-#157' of github.com:ericnor…
ericnordelo Dec 29, 2022
363422e
feat: add snippets
ericnordelo Dec 29, 2022
30a1fe0
feat: group core commands
ericnordelo Dec 29, 2022
cd54406
feat: update from reviews
ericnordelo Jan 2, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,9 @@ dmypy.json

# nile
*node.json*

# node
**/node_modules/

# docs
docs/build/
25 changes: 22 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,23 +41,42 @@ As a contributor, you are expected to fork this repository, work on your own for
tox -e lint
```

4. Add your files, commit, and push to your fork.
4. Update documentation ([see Documentation section](#documentation)).

5. Add your files, commit, and push to your fork.

```sh
git add some_file.py
git commit "Fix some bug #123"
git push origin fix/some-bug-#123
```

5. Go to [github.com/OpenZeppelin/nile](https://github.com/OpenZeppelin/nile) in your web browser and issue a new pull request.
6. Go to [github.com/OpenZeppelin/nile](https://github.com/OpenZeppelin/nile) in your web browser and issue a new pull request.
Begin the body of the PR with "Fixes #123" or "Resolves #123" to link the PR to the issue that it is resolving.
*IMPORTANT* Read the PR template very carefully and make sure to follow all the instructions. These instructions
refer to some very important conditions that your PR must meet in order to be accepted, such as making sure that all PR checks pass.

6. Maintainers will review your code and possibly ask for changes before your code is pulled into the main repository. We'll check that all tests pass, review the coding style, and check for general code correctness. If everything is OK, we'll merge your pull request and your code will be part of OpenZeppelin Nile.
7. Maintainers will review your code and possibly ask for changes before your code is pulled into the main repository. We'll check that all tests pass, review the coding style, and check for general code correctness. If everything is OK, we'll merge your pull request and your code will be part of OpenZeppelin Nile.

*IMPORTANT* Please pay attention to the maintainer's feedback, since it's a necessary step to keep up with the standards OpenZeppelin Nile attains to.

## Documentation

Before submitting the PR, you must update the corresponding documentation entries in the docs folder.

If you want to run the documentation UI locally:

1. Change directory into docs inside the project and run npm install.

```bash
cd docs && npm i
```

2. Build the docs and run the local server (default to localhost:8080). This will watch for changes in the docs/module folder, and update the UI accordingly.

```bash
npm run docs:watch
```

## Design Patterns

Expand Down
Loading