Merge pull request #989 from golemfactory/feature/JST-924/rental-and-…

…exe-unit-docs JST-924: Rearrange docs in the repo for improved maintenance
golemfactory · Jun 27, 2024 · aa69c63 · aa69c63
2 parents 0be9128 + 5993dbd
commit aa69c63
Show file tree

Hide file tree

Showing 12 changed files with 746 additions and 284 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,7 +13,7 @@ coverage/
 /examples/yacat/*.txt
 /examples/yacat/*.hash
 /examples/yacat/*.potfile
-/docs
+api-reference/
 logs/
 .cypress
 

diff --git a/.docs/summary-generator.cjs → .typedoc/summary-generator.cjs b/.docs/summary-generator.cjs → .typedoc/summary-generator.cjs
@@ -21,7 +21,7 @@ async function prepareDocAnchor(docsDir, type, file) {
 }
 
 (async () => {
-  const docsDir = process.argv[2] || "docs";
+  const docsDir = process.argv[2] || "api-reference";
   const directoryPath = path.join(__dirname, "..", docsDir);
   const logFilePath = path.join(process.argv[3] || docsDir, "overview.md");
   const logStream = fs.createWriteStream(logFilePath, { flags: "w" });

diff --git a/.docs/typedoc-frontmatter-theme.cjs → .typedoc/typedoc-frontmatter-theme.cjs b/.docs/typedoc-frontmatter-theme.cjs → .typedoc/typedoc-frontmatter-theme.cjs