ci: generate v2 docs using forge doc

[fadeev]

• generate protocol contracts docs in the docs/ directory using forge doc
• concatenates README and SUMMARY into a single index.md file so that it can be published in the docs
• modifies the URLs to ensure that it works with the docs website

Summary by CodeRabbit

• New Features

  • Added a .gitignore file to exclude the book/ directory from version control.
  • Introduced new documentation files and structures to enhance the organization and presentation of smart contract information, including README.md and SUMMARY.md.
  • Implemented new CSS styles for tables in documentation to improve layout and readability.

• Documentation

  • Updated and added comprehensive documentation files, including configuration files and detailed descriptions of smart contracts and their functionalities.

• Style

  • Standardized string delimiters in the YAML configuration for consistency.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The recent changes include updates to documentation and workflow files, enhancing structure and clarity. A new `.gitignore` file was added for the `v2/docs` directory to keep unnecessary files out of version control. Several documentation files were introduced, including a comprehensive README, a configuration file for documentation generation, and CSS styling for better presentation. Additionally, new smart contract files define interfaces and structures for handling revert scenarios and ERC20 token management within the ZetaChain ecosystem. ## Changes | Files | Change Summary | |-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| | `.github/workflows/...generated-files_v2.yaml` | Updated string delimiters from single quotes to double quotes for consistency. | | `v2/docs/.gitignore` | New file created to ignore the `book/` directory. | | `v2/docs/book.css` | Introduced CSS styles for tables to improve layout and readability in documentation. | | `v2/docs/book.toml` | New configuration file for documentation generation specifying source directory and output settings. | | `v2/docs/src/README.md` | New file providing an overview of V2 of the smart contract architecture with essential commands for developers. | | `v2/docs/src/SUMMARY.md` | New documentation summary file to organize and outline key contracts and interfaces related to EVM and ZEVM. | | `v2/docs/src/contracts/README.md` | New structured contents section for smart contracts documentation, linking to EVM and ZK-EVM documentation. | | `v2/docs/src/contracts/Revert.sol/...` | New files introducing the `Revertable` interface, `RevertContext`, and `RevertOptions` struct for handling revert scenarios. | | `v2/docs/src/contracts/evm/ERC20Custody.sol/...` | New contract file detailing the `ERC20Custody` contract for managing ERC20 token deposits on ZetaChain. | | `v2/docs/src/contracts/evm/GatewayEVM.sol/...` | New contract file for `GatewayEVM`, facilitating interactions with external smart contracts and managing cross-chain operations. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Contract participant Gateway participant TSS User->>Contract: Deposit Tokens Contract->>Gateway: Forward Deposit Request Gateway->>TSS: Validate Transaction TSS-->>Gateway: Confirmation Gateway->>Contract: Process Deposit Contract-->>User: Confirmation of Deposit ```

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.35%. Comparing base (100d765) to head (9ba0b31).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #334 +/- ## ======================================= Coverage 82.35% 82.35% ======================================= Files 7 7 Lines 306 306 Branches 99 99 ======================================= Hits 252 252 Misses 54 54 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[fadeev]

I tried fixing the generated files workflow, but I'm just going to do it in a separate PR.

[fadeev]

(ignore the path in URL, I put it into "frontend" for testing purposes)