Skip to content

Commit

Permalink
Feat: docs update page title and remove warn messages (#37)
Browse files Browse the repository at this point in the history
* feat: rename page title

* feat: remove pkg name since it is already on the parent pkg.json and add the version as the plugin version

* feat: remove warn cards since contracts are audited

* fix: remove version
  • Loading branch information
clauBv23 authored Feb 5, 2025
1 parent 81db7a2 commit e083ade
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 7 deletions.
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "@aragon/admin-plugin",
"description": "A template to fork from when developing an Aragon OSx plugin",
"version": "0.0.1-alpha.1",
"license": "AGPL-3.0-or-later",
"author": {
"name": "Aragon",
Expand Down
2 changes: 1 addition & 1 deletion packages/contracts/docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: admin
title: Admin
title: '@aragon/admin'
version: 1.x
prerelease: false
nav:
Expand Down
2 changes: 0 additions & 2 deletions packages/contracts/docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
= Admin

WARNING: This documentation shows the *build 2* which uses *1.4 protocol version*. Currently, these are being audited. Even though, contracts are backwards compatible, we do *NOT* recommend using these latest versions in production until audit is finished.

== Description

**Admin** is a governance plugin developed and maintained by the Aragon core team. Unlike most governance plugins that store and manage proposals, **Admin** operates as a direct execution tool. While it supports the **IProposal** standard of Aragon OSx, it bypasses proposal storage entirely. Instead, users can create and immediately execute proposals in a single transaction.
Expand Down
4 changes: 2 additions & 2 deletions packages/contracts/docs/modules/api/pages/Admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

[.contract]
[[Admin]]
=== `++Admin++` link:https://github.com/aragon/admin-plugin/blob/v1.3.0/packages/contracts/src/Admin.sol[{github-icon},role=heading-link]
=== `++Admin++` link:https://github.com/aragon/admin-plugin/blob/v1.2/packages/contracts/src/Admin.sol[{github-icon},role=heading-link]

v1.2 (Release 1, Build 2)

Expand Down Expand Up @@ -336,7 +336,7 @@ The [ERC-165](https://eips.ethereum.org/EIPS/eip-165) interface ID of the contra

[.contract]
[[AdminSetup]]
=== `++AdminSetup++` link:https://github.com/aragon/admin-plugin/blob/v1.3.0/packages/contracts/src/AdminSetup.sol[{github-icon},role=heading-link]
=== `++AdminSetup++` link:https://github.com/aragon/admin-plugin/blob/v1.2/packages/contracts/src/AdminSetup.sol[{github-icon},role=heading-link]

v1.2 (Release 1, Build 2)

Expand Down
2 changes: 1 addition & 1 deletion packages/contracts/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@aragon/admin-plugin",
"private": true,
"version": "1.2",
"repository": {
"type": "git",
"url": "https://github.com/aragon/admin-plugin"
Expand Down

0 comments on commit e083ade

Please sign in to comment.