Skip to content

Commit

Permalink
Add marginal docs improvements (#855)
Browse files Browse the repository at this point in the history
* improve docs

* fix sidebar
  • Loading branch information
martriay committed Dec 16, 2023
1 parent e7f63bb commit 441e6ce
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ nav:
- modules/ROOT/nav.adoc
asciidoc:
attributes:
page-sidebar-collapse-default: 'Access Control,Accounts,Introspection,Security,ERC20,ERC721,Upgrades'
page-sidebar-collapse-default: 'Access,Accounts,Introspection,Security,ERC20,ERC721,Upgrades'
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

* Modules
** xref:access.adoc[Access Control]
** xref:access.adoc[Access]
*** xref:/api/access.adoc[API Reference]
** xref:accounts.adoc[Accounts]
Expand Down
5 changes: 3 additions & 2 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

= Contracts for Cairo

*A library for secure smart contract development* written in Cairo for {starknet}, a decentralized ZK Rollup.
*A library for secure smart contract development* written in Cairo for {starknet}. This library consists of a set of xref:components.adoc[reusable components] to build custom smart contracts, as well as
ready-to-deploy xref:presets.adoc[presets]. You can also find other xref:utilities.adoc[utilities] including xref:interfaces.adoc[interfaces and dispatchers].

WARNING: This repo contains highly experimental code. Expect rapid iteration. *Use at your own risk.*

Expand Down Expand Up @@ -63,7 +64,7 @@ WARNING: Make sure the tag matches the target release.

== Basic usage

This is how it looks to build an ERC20 contract using the xref:erc20.adoc[ERC20] module.
This is how it looks to build an ERC20 contract using the xref:erc20.adoc[ERC20 component].
Copy the code into `src/lib.cairo`.

[,javascript]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/wizard.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Cairo Contracts Wizard
= Wizard for Cairo
:page-notoc:

Not sure where to start? Use the interactive generator below to bootstrap your
Expand Down

0 comments on commit 441e6ce

Please sign in to comment.