Merge pull request #149 from threshold-network/split-api-docs-to-multiple-files

Split contracts API doc into multiple files

Having all the contracts documented in one common file turned out to be hard to
render by the GitBook. We're switching to documenting each contract file in
a separate Markdown file.

As the generated files will be much smaller now and GitBook has its own file
ON THIS PAGE section, we don't need to generate Table of Contents. The one thing
that we also change as part of this PR is rsyncDelete setting - we'll have it
set to true, in order to delete documentation of contracts which get removed
from the repo. As we're not working directly on a main branch, this isn't
dangerous (we'll see all the deletions in the PR diff).

As part of this PR we also unify the naming convention for the YAML files - we
want to use .yml everywhere. With .yaml used in contracts-docs workflow, the
filter job was misconfigured.

Author: pdyraga

.github/workflows/contracts-docs.yaml .github/workflows/contracts-docs.yml.github/workflows/contracts-docs.yaml renamed to .github/workflows/contracts-docs.yml

@@ -42,6 +42,7 @@ jobs:
     uses: keep-network/ci/.github/workflows/reusable-solidity-docs.yml@main
     with:
       publish: false
+      addTOC: false
       commentPR: true
       exportAsGHArtifacts: true
 
@@ -58,12 +59,14 @@ jobs:
     uses: keep-network/ci/.github/workflows/reusable-solidity-docs.yml@main
     with:
       publish: true
+      addTOC: false
       verifyCommits: true
       destinationRepo: threshold-network/threshold
       destinationFolder: ./docs/app-development/staking-contract-and-dao/staking-contract-and-dao-api
       destinationBaseBranch: main
       userEmail: 38324465+thesis-valkyrie@users.noreply.github.com
       userName: Valkyrie
+      rsyncDelete: true
     secrets:
       githubToken: ${{ secrets.THRESHOLD_DOCS_GITHUB_TOKEN }}
       gpgPrivateKey: ${{ secrets.THRESHOLD_DOCS_GPG_PRIVATE_KEY_BASE64 }}

.github/workflows/contracts.yaml .github/workflows/contracts.yml.github/workflows/contracts.yaml renamed to .github/workflows/contracts.yml

@@ -124,7 +124,7 @@ const config: HardhatUserConfig = {
   docgen: {
     outputDir: "generated-docs",
     templates: "docgen-templates",
-    pages: "single", // `single`, `items` or `files`
+    pages: "files", // `single`, `items` or `files`
     exclude: ["./test"],
   },
 }