Fix/reference guide auto doc (#327)

* ci: returns template moddified * fix: delete unused templates, update package.json * fix: replace undesired characters in documentation, returns.hbs modified * doc: add some returns docu, fixed miss replace * fix: PR #327 suggested changes, broken links solved * ci: add stripTags helper in returns.hbs to have type and description in same line * fix: comment in common-clients that won't render in dev-portal
aragon · Feb 22, 2024 · 2b056d9 · 2b056d9
1 parent 4d07c15
commit 2b056d9
Show file tree

Hide file tree

Showing 96 changed files with 272 additions and 761 deletions.
diff --git a/docs/sdk/03-update-security-check/index.md b/docs/sdk/03-update-security-check/index.md
@@ -168,13 +168,13 @@ The `applyUpdate` action CAN be wrapped by `grant` and `revoke` actions:
 |                | `"invalidGrantRootPermissionPermissionName"`  | The `permissionName` must be `ROOT_PERMISSION`.                                                                                                      |
 |                | `"invalidRevokeRootPermissionPermissionName"` | "                                                                                                                                                    |
 
-[execute]: (../../../../osx/01-how-it-works/01-core/01-dao/01-actions.md#a-deep-dive-into-actions-and-execution)
-[action]: (../../../../osx/01-how-it-works/01-core/01-dao/01-actions.md#actions)
-[allowfailuremap]: (../../../../osx/01-how-it-works/01-core/01-dao/01-actions.md#allowing-for-failure)
-[initializefrom]: (../../../../osx/03-reference-guide/core/dao/DAO.md#external-function-initializefrom)
+[execute]: (../../../../osx/how-it-works/core/dao/actions#a-deep-dive-into-actions-and-execution)
+[action]: (../../../../osx/how-it-works/core/dao/actions#actions)
+[allowfailuremap]: (../../../../osx/how-it-works/core/dao/actions#allowing-for-failure)
+[initializefrom]: (../../../../osx/reference-guide/core/dao#external-function-initializefrom)
 [oz-upgradeto]: https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/3d4c0d5741b131c231e558d7a6213392ab3672a5/contracts/proxy/utils/UUPSUpgradeable.sol#L74-L77
 [oz-upgradetoandcall]: https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/3d4c0d5741b131c231e558d7a6213392ab3672a5/contracts/proxy/utils/UUPSUpgradeable.sol#L89-L92
-[applyupdate]: (../../../../osx//03-reference-guide/framework/plugin/setup/PluginSetupProcessor.md#external-function-applyupdate)
-[grant]: (../../../../osx//03-reference-guide/core/permission/PermissionManager.md#external-function-grant)
-[revoke]: (../../../../osx//03-reference-guide/core/permission/PermissionManager.md#external-function-revoke)
-[build-metadata]: (../../../../osx/02-how-to-guides/02-plugin-development/07-publication/02-metadata.md#plugin-metadata-specification)
+[applyupdate]: (../../../../osx/reference-guide/framework/plugin/setup/PluginSetupProcessor#external-function-applyupdate)
+[grant]: (../../../../osx/reference-guide/core/permission/PermissionManager#external-function-grant)
+[revoke]: (../../../../osx/reference-guide/core/permission/PermissionManager#external-function-revoke)
+[build-metadata]: (../../../../osx/how-to-guides/plugin-development/publication/metadata#plugin-metadata-specification)
diff --git a/docs/template/all-docs/all-docs.hbs b/docs/template/all-docs/all-docs.hbs
diff --git a/docs/template/all-docs/docs/body/access.hbs b/docs/template/all-docs/docs/body/access.hbs
diff --git a/docs/template/all-docs/docs/body/augments.hbs b/docs/template/all-docs/docs/body/augments.hbs
diff --git a/docs/template/all-docs/docs/body/authors.hbs b/docs/template/all-docs/docs/body/authors.hbs
diff --git a/docs/template/all-docs/docs/body/body.hbs b/docs/template/all-docs/docs/body/body.hbs
diff --git a/docs/template/all-docs/docs/body/category.hbs b/docs/template/all-docs/docs/body/category.hbs
diff --git a/docs/template/all-docs/docs/body/chainable.hbs b/docs/template/all-docs/docs/body/chainable.hbs
diff --git a/docs/template/all-docs/docs/body/copyright.hbs b/docs/template/all-docs/docs/body/copyright.hbs
diff --git a/docs/template/all-docs/docs/body/customTags.hbs b/docs/template/all-docs/docs/body/customTags.hbs
diff --git a/docs/template/all-docs/docs/body/default.hbs b/docs/template/all-docs/docs/body/default.hbs
diff --git a/docs/template/all-docs/docs/body/deprecated.hbs b/docs/template/all-docs/docs/body/deprecated.hbs
diff --git a/docs/template/all-docs/docs/body/description.hbs b/docs/template/all-docs/docs/body/description.hbs
diff --git a/docs/template/all-docs/docs/body/examples.hbs b/docs/template/all-docs/docs/body/examples.hbs
diff --git a/docs/template/all-docs/docs/body/fires.hbs b/docs/template/all-docs/docs/body/fires.hbs
diff --git a/docs/template/all-docs/docs/body/implements.hbs b/docs/template/all-docs/docs/body/implements.hbs
diff --git a/docs/template/all-docs/docs/body/license.hbs b/docs/template/all-docs/docs/body/license.hbs
diff --git a/docs/template/all-docs/docs/body/mixes.hbs b/docs/template/all-docs/docs/body/mixes.hbs
diff --git a/docs/template/all-docs/docs/body/overrides.hbs b/docs/template/all-docs/docs/body/overrides.hbs
diff --git a/docs/template/all-docs/docs/body/params/param-table-name.hbs b/docs/template/all-docs/docs/body/params/param-table-name.hbs
diff --git a/docs/template/all-docs/docs/body/params/params-list.hbs b/docs/template/all-docs/docs/body/params/params-list.hbs
diff --git a/docs/template/all-docs/docs/body/params/params-table-html.hbs b/docs/template/all-docs/docs/body/params/params-table-html.hbs
diff --git a/docs/template/all-docs/docs/body/params/params-table.hbs b/docs/template/all-docs/docs/body/params/params-table.hbs
diff --git a/docs/template/all-docs/docs/body/params/params.hbs b/docs/template/all-docs/docs/body/params/params.hbs
diff --git a/docs/template/all-docs/docs/body/properties/properties-list.hbs b/docs/template/all-docs/docs/body/properties/properties-list.hbs
diff --git a/docs/template/all-docs/docs/body/properties/properties-table-html.hbs b/docs/template/all-docs/docs/body/properties/properties-table-html.hbs
diff --git a/docs/template/all-docs/docs/body/properties/properties-table.hbs b/docs/template/all-docs/docs/body/properties/properties-table.hbs
diff --git a/docs/template/all-docs/docs/body/properties/properties.hbs b/docs/template/all-docs/docs/body/properties/properties.hbs
diff --git a/docs/template/all-docs/docs/body/readOnly.hbs b/docs/template/all-docs/docs/body/readOnly.hbs
diff --git a/docs/template/all-docs/docs/body/requires.hbs b/docs/template/all-docs/docs/body/requires.hbs
diff --git a/docs/template/all-docs/docs/body/scope.hbs b/docs/template/all-docs/docs/body/scope.hbs
diff --git a/docs/template/all-docs/docs/body/see.hbs b/docs/template/all-docs/docs/body/see.hbs
diff --git a/docs/template/all-docs/docs/body/since.hbs b/docs/template/all-docs/docs/body/since.hbs
diff --git a/docs/template/all-docs/docs/body/summary.hbs b/docs/template/all-docs/docs/body/summary.hbs
diff --git a/docs/template/all-docs/docs/body/this.hbs b/docs/template/all-docs/docs/body/this.hbs
diff --git a/docs/template/all-docs/docs/body/throws.hbs b/docs/template/all-docs/docs/body/throws.hbs
diff --git a/docs/template/all-docs/docs/body/todo.hbs b/docs/template/all-docs/docs/body/todo.hbs
diff --git a/docs/template/all-docs/docs/body/version.hbs b/docs/template/all-docs/docs/body/version.hbs
diff --git a/docs/template/all-docs/docs/docs.hbs b/docs/template/all-docs/docs/docs.hbs
diff --git a/docs/template/all-docs/docs/header.hbs b/docs/template/all-docs/docs/header.hbs
diff --git a/docs/template/all-docs/docs/member-index/member-index-grouped.hbs b/docs/template/all-docs/docs/member-index/member-index-grouped.hbs
diff --git a/docs/template/all-docs/docs/member-index/member-index-list.hbs b/docs/template/all-docs/docs/member-index/member-index-list.hbs
diff --git a/docs/template/all-docs/docs/member-index/member-index.hbs b/docs/template/all-docs/docs/member-index/member-index.hbs
diff --git a/docs/template/all-docs/docs/members.hbs b/docs/template/all-docs/docs/members.hbs
diff --git a/docs/template/main-index/global-index/global-index-dl.hbs b/docs/template/main-index/global-index/global-index-dl.hbs
diff --git a/docs/template/main-index/global-index/global-index-grouped.hbs b/docs/template/main-index/global-index/global-index-grouped.hbs
diff --git a/docs/template/main-index/global-index/global-index-kinds.hbs b/docs/template/main-index/global-index/global-index-kinds.hbs