This PR introduces a fully automated process for generating API reference documentation for both JavaScript and Solidity files, with a focus on compatibility with MDX formatting. The key changes include:
Compilation of Hardhat and Forge Projects:
Ensures both Hardhat and Forge projects are compiled before generating documentation.
API Documentation Generation:
Uses Hardhat's solidity-docgen to generate Markdown (.mdx) documentation files for the Solidity contracts.
Uses jsdoc-to-markdown to generate Markdown (.mdx) documentation files for the JavaScript files.
Automated Index File Creation:
Introduces a TypeScript script (generate-index-files.ts) that creates index.mdx files with appropriate headers and bullet points for each directory and its contents.
Prettier Formatting:
Ensures all generated documentation files are formatted consistently using Prettier.
This PR introduces a fully automated process for generating API reference documentation for both JavaScript and Solidity files, with a focus on compatibility with MDX formatting. The key changes include:
Compilation of Hardhat and Forge Projects:
API Documentation Generation:
solidity-docgento generate Markdown (.mdx) documentation files for the Solidity contracts.jsdoc-to-markdownto generate Markdown (.mdx) documentation files for the JavaScript files.Automated Index File Creation:
generate-index-files.ts) that createsindex.mdxfiles with appropriate headers and bullet points for each directory and its contents.Prettier Formatting: