Skip to content

Commit

Permalink
docs(contract): improve the content of the index.md file used as TOC …
Browse files Browse the repository at this point in the history
…for NatSpec docs
  • Loading branch information
ctrlc03 committed Dec 6, 2023
1 parent d927d61 commit c3450b3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion website/src/scripts/setupSolidityDocs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ function generateMarkdownLinks(dir, relativePath = ""): string {
// copy over the directory
copyDirectory(sourceDir, solidityDocDir);
// generate index.md content
const content = "# Solidity NatSpec Documentation\n\n" + generateMarkdownLinks(solidityDocDir, "solidity-docs");
let content = "# Solidity NatSpec Documentation\n\nThis directory provides autogenerated ";
content += "documentation for the [MACI v1.x smart contracts](/docs/contracts/) and interfaces ";
content += "based on the [NatSpec Format](https://docs.soliditylang.org/en/latest/natspec-format.html) ";
content += "for Solidity contracts.\n\n## MACI contracts and interfaces\n";
content += "[TOC of contracts, linking to pages]\n\n";
content += generateMarkdownLinks(solidityDocDir, "solidity-docs");

// save the content to index.md
fileS.writeFileSync(pathX.join(solidityDocDir, "index.md"), content, "utf8");

0 comments on commit c3450b3

Please sign in to comment.