Skip to content

Commit 7771d7a

Browse 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 delitions in the PR diff).
1 parent c9091e9 commit 7771d7a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

hardhat.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ const config: HardhatUserConfig = {
124124
docgen: {
125125
outputDir: "generated-docs",
126126
templates: "docgen-templates",
127-
pages: "single", // `single`, `items` or `files`
127+
pages: "files", // `single`, `items` or `files`
128128
exclude: ["./test"],
129129
},
130130
}

0 commit comments

Comments
 (0)