search

zeta-chain / docs

Documentation for ZetaChain
https://www.zetachain.com/docs/
MIT License
74 stars 59 forks source link

ci: publish toolkit docs under frontend #476

Closed fadeev closed 1 month ago

fadeev commented 1 month ago

Summary by CodeRabbit

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 30, 2024 7:59am
coderabbitai[bot] commented 1 month ago
📝 Walkthrough ## Walkthrough The pull request introduces significant changes, primarily focusing on restructuring the documentation for the `@zetachain/toolkit` package. Key modifications include the relocation of documentation files to a new directory structure, the deletion of various JavaScript and HTML files related to search and token management functionalities, and the removal of CSS files that provided theming and styling capabilities. These adjustments aim to streamline the organization of documentation and eliminate outdated or redundant components. ## Changes | File(s) | Change Summary | |-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `.github/workflows/update-from-toolkit.yaml` | Updated the directory structure for toolkit documentation from `public/packages/toolkit` to `src/pages/developers/frontend/toolkit`, modifying commands for file creation, removal, and copying accordingly. | | `public/packages/toolkit/assets/*.css` | Deleted CSS files, including `highlight.css` and `style.css`, which contained styles for syntax highlighting and theming, removing associated styling capabilities from the application. | | `public/packages/toolkit/assets/*.js` | Removed JavaScript files, including `main.js`, `navigation.js`, `search.js`, which provided search functionalities and global variables related to navigation and search data, eliminating their associated functionalities. | | `public/packages/toolkit/classes/ZetaChainClient.html` | Deleted documentation for the `ZetaChainClient` class, which included methods for managing deposits, withdrawals, and token transfers, removing guidance for developers on utilizing this class. | | `public/packages/toolkit/functions/*.html` | Removed multiple function documentation files, including `deposit.html`, `getBalances.html`, `getChainId.html`, and others, which provided details on various functions within the toolkit, affecting the overall documentation accessibility. | | `public/packages/toolkit/interfaces/*.html` | Deleted interface documentation files, including `TokenBalance.html` and `ZetaChainClientParamsBase.html`, which defined key interfaces and their properties, impacting the understanding of these interfaces for developers. | | `public/packages/toolkit/modules.html` | Removed the main documentation file for the `@zetachain/toolkit` package, which provided an overview and navigation for the toolkit's components, eliminating centralized access to toolkit information. | | `public/packages/toolkit/types/ZetaChainClientParams.html` | Deleted type alias documentation for `ZetaChainClientParams`, which combined various types and interfaces, removing guidance on its structure and usage. | ## Possibly related PRs - **#375**: Involves restructuring documentation paths, aligning with the updates made in this PR to enhance clarity for developers exploring ZetaChain's capabilities. - **#406**: Introduces a new GitHub Actions workflow for reindexing embeddings, relating to the main PR's focus on updating documentation paths to improve overall functionality and organization. - **#425**: Updates module documentation, relevant to the main PR's changes in documentation structure, ensuring that information remains accurate and reflects the current state of the codebase. - **#433**: Documentation updates regarding the Gateway functionality complement the main PR's restructuring of documentation paths, enhancing clarity and accessibility of information related to ZetaChain's interoperability features.
📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between f37a3765ee272ee4344cedf111b0a8c44a981673 and e3a28c5657992dd8da11544f911469b2218d8837.
📒 Files selected for processing (26) * .github/workflows/update-from-toolkit.yaml (1 hunks) * public/packages/toolkit/assets/highlight.css (0 hunks) * public/packages/toolkit/assets/main.js (0 hunks) * public/packages/toolkit/assets/navigation.js (0 hunks) * public/packages/toolkit/assets/search.js (0 hunks) * public/packages/toolkit/assets/style.css (0 hunks) * public/packages/toolkit/classes/ZetaChainClient.html (0 hunks) * public/packages/toolkit/functions/deposit.html (0 hunks) * public/packages/toolkit/functions/getBalances.html (0 hunks) * public/packages/toolkit/functions/getChainId.html (0 hunks) * public/packages/toolkit/functions/getEndpoints.html (0 hunks) * public/packages/toolkit/functions/getFees.html (0 hunks) * public/packages/toolkit/functions/getForeignCoins.html (0 hunks) * public/packages/toolkit/functions/getPools.html (0 hunks) * public/packages/toolkit/functions/getSupportedChains.html (0 hunks) * public/packages/toolkit/functions/prepareData.html (0 hunks) * public/packages/toolkit/functions/prepareParams.html (0 hunks) * public/packages/toolkit/functions/sendZRC20.html (0 hunks) * public/packages/toolkit/functions/sendZeta.html (0 hunks) * public/packages/toolkit/functions/trackCCTX.html (0 hunks) * public/packages/toolkit/functions/withdraw.html (0 hunks) * public/packages/toolkit/index.html (0 hunks) * public/packages/toolkit/interfaces/TokenBalance.html (0 hunks) * public/packages/toolkit/interfaces/ZetaChainClientParamsBase.html (0 hunks) * public/packages/toolkit/modules.html (0 hunks) * public/packages/toolkit/types/ZetaChainClientParams.html (0 hunks)
💤 Files with no reviewable changes (25) * public/packages/toolkit/assets/highlight.css * public/packages/toolkit/assets/main.js * public/packages/toolkit/assets/navigation.js * public/packages/toolkit/assets/search.js * public/packages/toolkit/assets/style.css * public/packages/toolkit/classes/ZetaChainClient.html * public/packages/toolkit/functions/deposit.html * public/packages/toolkit/functions/getBalances.html * public/packages/toolkit/functions/getChainId.html * public/packages/toolkit/functions/getEndpoints.html * public/packages/toolkit/functions/getFees.html * public/packages/toolkit/functions/getForeignCoins.html * public/packages/toolkit/functions/getPools.html * public/packages/toolkit/functions/getSupportedChains.html * public/packages/toolkit/functions/prepareData.html * public/packages/toolkit/functions/prepareParams.html * public/packages/toolkit/functions/sendZRC20.html * public/packages/toolkit/functions/sendZeta.html * public/packages/toolkit/functions/trackCCTX.html * public/packages/toolkit/functions/withdraw.html * public/packages/toolkit/index.html * public/packages/toolkit/interfaces/TokenBalance.html * public/packages/toolkit/interfaces/ZetaChainClientParamsBase.html * public/packages/toolkit/modules.html * public/packages/toolkit/types/ZetaChainClientParams.html
🧰 Additional context used
🪛 actionlint
.github/workflows/update-from-toolkit.yaml
31-31: workflow command "set-output" was deprecated. use `echo "{name}={value}" >> $GITHUB_OUTPUT` instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions (deprecated-commands)
🔇 Additional comments (3)
.github/workflows/update-from-toolkit.yaml (3)
`24-26`: **Directory structure modification appears correct and aligned with PR objectives.** The changes to update the toolkit documentation path from `public/packages/toolkit` to `src/pages/developers/frontend/toolkit` have been implemented correctly. The commands for directory creation, existing file removal, and new file copying are accurate and maintain the intended functionality. --- `32-32`: **Git add command correctly updated to reflect new directory structure.** The `git add` command has been appropriately modified to track changes in the new `src/pages/developers/frontend/toolkit` directory, maintaining consistency with the earlier directory structure modifications. --- `32-32`: _:warning: Potential issue_ **Update deprecated `set-output` command to new syntax.** The `set-output` workflow command has been deprecated. To ensure the longevity and maintainability of this workflow, please update the command to use the new syntax. Replace the deprecated command with the following: ```diff - git diff --cached --exit-code || echo "::set-output name=changed::true" + git diff --cached --exit-code || echo "changed=true" >> $GITHUB_OUTPUT ``` This change aligns with the current GitHub Actions best practices and prevents potential future compatibility issues. > Likely invalid or redundant comment.
--- 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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.