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

Integrate docsite #396

Merged
merged 47 commits into from
Aug 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
4b28628
migrate docs to antora
martriay Jul 13, 2022
3377f99
Merge branch 'main' into integrate-docsite
martriay Jul 13, 2022
2ae9be0
Merge branch 'main' into integrate-docsite
martriay Jul 13, 2022
c65892e
add docs bump to RELEASING
martriay Jul 13, 2022
e1d9d78
migrate from markdown to adoc format
martriay Jul 13, 2022
fb6c98e
update antora name
martriay Jul 14, 2022
0e7aaa0
fix index adoc format
martriay Jul 14, 2022
caae432
Apply suggestions from code review
martriay Jul 15, 2022
377e09b
add crosslink to solidity, remove advisory
martriay Jul 15, 2022
96dac3d
fix extensibility
martriay Jul 15, 2022
39cb111
Merge branch 'main' into integrate-docsite
martriay Jul 15, 2022
131435e
add admonitions and scape underscores
martriay Jul 15, 2022
15374df
update navbar
martriay Jul 15, 2022
c03729b
merge access control docs
martriay Jul 15, 2022
0707b85
Merge branch 'main' into integrate-docsite
martriay Jul 15, 2022
d38e60a
Merge branch 'main' into integrate-docsite
martriay Jul 22, 2022
54ccec5
Apply suggestions from code review
martriay Jul 22, 2022
797d2b3
remove unused style. try toc clause
martriay Jul 22, 2022
843e794
Merge branch 'integrate-docsite' of https://github.com/OpenZeppelin/c…
martriay Jul 22, 2022
62efa2d
return toc. fix links for access
martriay Jul 22, 2022
c3998d9
fix access links
martriay Jul 23, 2022
a6da3ff
fix account doc links
martriay Jul 23, 2022
930748a
fix erc20 doc links
martriay Jul 23, 2022
14d8aa0
fix erc721 doc links
martriay Jul 23, 2022
9c7b0cb
fix extensibility doc links
martriay Jul 23, 2022
22b6ffb
fix introspection doc links
martriay Jul 23, 2022
ff2ed86
fix proxies doc links
martriay Jul 23, 2022
f88c899
fix security doc links
martriay Jul 23, 2022
351c6a4
fix utils doc links
martriay Jul 23, 2022
c163952
fix links
martriay Jul 23, 2022
fad466c
fix utils doc links
martriay Jul 23, 2022
caefaca
fix links and references
martriay Jul 23, 2022
15991b0
fix links
martriay Jul 23, 2022
ab3deb2
inline None.
martriay Jul 23, 2022
73c8086
adapt access accounts erc20 to new dir structure
martriay Jul 25, 2022
5f0d64c
adapt erc721 to new dir structure
martriay Jul 25, 2022
581f979
adapt extensibility and introspection to new dir structure
martriay Jul 25, 2022
fdee3f5
adapt proxies security utilities to new dir structure
martriay Jul 25, 2022
2b6c7b9
Merge branch 'main' into integrate-docsite
martriay Jul 25, 2022
00cf948
fix merge conflict
martriay Jul 25, 2022
6e06c79
apply review suggestions
martriay Jul 26, 2022
62a854d
Update docs/modules/ROOT/pages/accounts.adoc
martriay Jul 26, 2022
cd3a373
Merge branch 'main' into integrate-docsite
martriay Jul 26, 2022
57a097a
fix formatting
martriay Jul 29, 2022
517058f
escape character
martriay Jul 29, 2022
0cd453b
Update docs/modules/ROOT/pages/index.adoc
martriay Aug 3, 2022
10a0c3a
replace links with permalinks
martriay Aug 3, 2022
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
14 changes: 12 additions & 2 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,24 @@ to
# OpenZeppelin Contracts for Cairo v0.2.0 (account/Account.cairo)
```

(3) Create a release branch and add a tag to it. This branch can be useful if we need to push a hot fix on top of an existing release in the case of a bug.
(3) Update documentation version in `docs/antora.yml`
martriay marked this conversation as resolved.
Show resolved Hide resolved

```diff
name: cairo-contracts
title: Contracts for Cairo
-version: 0.1.0
+version: 0.2.0
(...)
```

(4) Create a release branch and add a tag to it. This branch can be useful if we need to push a hot fix on top of an existing release in the case of a bug.

```sh
git checkout -b release-0.2.0
git tag v0.2.0
```

(4) Push the tag to the main repository, [triggering the CI and release process](https://github.com/OpenZeppelin/cairo-contracts/blob/b27101eb826fae73f49751fa384c2a0ff3377af2/.github/workflows/python-app.yml#L60).
(5) Push the tag to the main repository, [triggering the CI and release process](https://github.com/OpenZeppelin/cairo-contracts/blob/b27101eb826fae73f49751fa384c2a0ff3377af2/.github/workflows/python-app.yml#L60).

```sh
git push origin v0.2.0
Expand Down
Loading