Skip to content

Commit

Permalink
docs: add rc tag to antora docs and improve security warning in docs (#…
Browse files Browse the repository at this point in the history
…267)

Add the rc tag to the docs so we can publish them before the audit. It
should be shown as `0.1.0-rc` on the site. I also made clear in the
warning that this hasn't been audited yet.

Signed-off-by: Gustavo Gonzalez <gustavo.gonzalez@openzeppelin.com>
  • Loading branch information
ggonzalez94 authored Aug 29, 2024
1 parent d4f57e6 commit 08d7fcf
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: contracts-stylus
title: Contracts for Stylus
version: 0.1.0
prerelease: '-rc' #we can remove this with the official release
nav:
- modules/ROOT/nav.adoc
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

*A library for secure smart contract development* written in Rust for {stylus}.

WARNING: This repo contains highly experimental code. *Use at your own risk.*
WARNING: This repo contains highly experimental code. It has never been audited nor thoroughly reviewed for security vulnerabilities. *Use at your own risk.*

NOTE: You can track our roadmap in our https://github.com/orgs/OpenZeppelin/projects/35[Github Project].

0 comments on commit 08d7fcf

Please sign in to comment.