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 marginal docs improvements #855

Merged
merged 2 commits into from
Dec 16, 2023
Merged

Add marginal docs improvements #855

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b1e72a
improve docs
martriay Dec 13, 2023
7280597
fix sidebar
martriay Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc
View file
Open in desktop
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]
Copy link
Member

Choose a reason for hiding this comment

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

We need to update the entry in antora.yml from:

page-sidebar-collapse-default: 'Access Control,Accounts,Introspection,Security,ERC20,ERC721,Upgrades'

to

page-sidebar-collapse-default: 'Access,Accounts,Introspection,Security,ERC20,ERC721,Upgrades'

*** xref:/api/access.adoc[API Reference]

** xref:accounts.adoc[Accounts]
Expand Down
5 changes: 3 additions & 2 deletions docs/modules/ROOT/pages/index.adoc
View file
Open in desktop
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
View file
Open in desktop
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