docs compile, pending overview

aragon · Feb 25, 2025 · 34956bb · 34956bb
1 parent db88689
commit 34956bb
Show file tree

Hide file tree

Showing 9 changed files with 3,239 additions and 341 deletions.
diff --git a/README.adoc b/README.adoc
@@ -2,4 +2,11 @@
 
 == Core
 
-{{VotingEscrowIncreasing}}
+{{VotingEscrow}}
+{{ExitQueue}}
+{{QuadraticIncreasingEscrow}}
+{{SimpleGaugeVoter}}
+{{SimpleGaugeVoterSetup}}
+{{GaugesDAOFactory}}
+{{Lock}}
+{{Clock}}
diff --git a/docs/modules/api/nav.adoc b/docs/modules/api/nav.adoc
@@ -1 +1,2 @@
 .API
+* xref:ve-governance.adoc[Ve Governance]
diff --git a/docs/modules/api/pages/ve-governance.adoc b/docs/modules/api/pages/ve-governance.adoc
diff --git a/docs/templates/contract.hbs b/docs/templates/contract.hbs
diff --git a/docs/templates/helpers.js b/docs/templates/helpers.js
diff --git a/docs/templates/page.hbs b/docs/templates/page.hbs
diff --git a/docs/templates/properties.js b/docs/templates/properties.js
diff --git a/package.json b/package.json
@@ -8,7 +8,7 @@
     "solc": "0.8.17"
   },
   "scripts": {
-    "docs": "script/prepare-docs.sh && node ./script/prepare-docs.js"
+    "docs": "script/prepare-docs.sh && bun ./script/prepare-docs.js"
   },
   "repository": {
     "type": "git",

diff --git a/script/prepare-docs.js b/script/prepare-docs.js
@@ -108,7 +108,6 @@ async function main() {
 
   const o = await output;
   console.log("Generating docs...");
-  console.log("Output", o);
   await docgen.main([{ input, output: o }], config);
 
   const navOutput = execSync(`${RUNTIME} script/gen-nav.js ${apiPath}/pages`, {
@@ -118,7 +117,6 @@ async function main() {
   // Write the output to the target file
   const targetFilePath = `${apiPath}/nav.adoc`;
   console.log("Writing nav to", targetFilePath);
-  console.log(navOutput);
   fs.writeFileSync(targetFilePath, navOutput, "utf8");
 
   fs.rm(templatesPath, { recursive: true, force: true }, () => {});