Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev #18

Closed
wants to merge 3 commits into from
Closed

Dev #18

wants to merge 3 commits into from

Conversation

bangjelkoski
Copy link
Collaborator

@bangjelkoski bangjelkoski commented Nov 4, 2024

Summary by CodeRabbit

  • Chores
    • Removed outdated documentation files related to various modules, including README files, guides, and parameter definitions for the Injective blockchain.
    • Deleted files included summaries on the Injective blockchain, CosmWasm developers, guides for creating smart contracts, and various other developer resources.
    • Eliminated files that detailed state management, message structures, and events for the Peggy and Oracle modules, enhancing overall documentation clarity.

Copy link

coderabbitai bot commented Nov 4, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request involves the deletion of multiple documentation files related to the Injective blockchain and its modules. The removed files include README documents, guides, and state management files across various modules such as CosmWasm developers, exchange, insurance, and oracle. The deletions encompass introductory content, detailed guides, and specific operational documentation that provided insights into functionalities, message structures, and governance processes within the Injective ecosystem.

Changes

File Path Change Summary
.gitbook/README.md Deleted overview of the Injective blockchain and its features.
.gitbook/SUMMARY.md Deleted comprehensive table of contents for Injective documentation.
.gitbook/developers/cosmwasm-developers/README.md Deleted introduction to CosmWasm smart contracting platform.
.gitbook/developers/cosmwasm-developers/guides/README.md Deleted header for guides related to CosmWasm developers.
.gitbook/developers/cosmwasm-developers/guides/create-your-swap-contract.md Deleted guide for creating a swap contract on Injective.
.gitbook/developers/cosmwasm-developers/guides/creating-uis.md Deleted guidance on creating UIs for dApps on Injective.
.gitbook/developers/cosmwasm-developers/guides/local-development.md Deleted guide for deploying cw20 contracts on local Injective network.
.gitbook/developers/cosmwasm-developers/guides/mainnet-deployment.md Deleted guide for deploying CosmWasm contracts on Injective Mainnet.
.gitbook/developers/cosmwasm-developers/guides/whitelisting-deployment-address.md Deleted guidelines for whitelisting deployment addresses on Injective.
.gitbook/developers/cosmwasm-developers/injective-test-tube.md Deleted documentation for injective-test-tube testing library.
.gitbook/developers/cosmwasm-developers/page-1.md Deleted documentation for CW20 Adapter Contract.
.gitbook/developers/cosmwasm-developers/your-first-smart-contract.md Deleted guide for setting up a first smart contract.
.gitbook/developers/evm-developers.md Deleted placeholder for EVM developers documentation.
.gitbook/developers/exchange-developers/README.md Deleted documentation for developers building on Injective's exchange.
.gitbook/developers/exchange-developers/provider-oracle.md Deleted guide for launching oracle providers on Injective.
.gitbook/developers/getting-started/README.md Deleted introductory content for developers starting with Injective.
.gitbook/developers/getting-started/guides/README.md Deleted header for simple developer guides.
.gitbook/developers/getting-started/guides/convert-addresses.md Deleted guide on converting addresses between formats.
.gitbook/developers/getting-started/guides/testnet-proposals.md Deleted guidance on submitting proposals on the testnet.
.gitbook/developers/modules/README.md Deleted placeholder for modules documentation.
.gitbook/developers/modules/core/README.md Deleted overview of core modules within Cosmos SDK.
.gitbook/developers/modules/core/auth/README.md Deleted documentation for the x/auth module.
.gitbook/developers/modules/core/authz/README.md Deleted documentation for the x/authz module.
.gitbook/developers/modules/core/bank/README.md Deleted documentation for the x/bank module.
.gitbook/developers/modules/core/circuit/README.md Deleted documentation for the Circuit Breaker functionality.
.gitbook/developers/modules/core/consensus/README.md Deleted documentation for the x/consensus module.
.gitbook/developers/modules/core/crisis/README.md Deleted documentation for the crisis module.
.gitbook/developers/modules/core/distribution/README.md Deleted documentation for the distribution module.
.gitbook/developers/modules/core/evidence/README.md Deleted documentation for the evidence module.
.gitbook/developers/modules/core/feegrant/README.md Deleted documentation for the fee grant module.
.gitbook/developers/modules/core/genutil/README.md Deleted documentation for genesis utilities.
.gitbook/developers/modules/core/genutils.md Deleted documentation for the Genutils module.
.gitbook/developers/modules/core/gov/README.md Deleted documentation for the Governance module.
.gitbook/developers/modules/core/group/README.md Deleted documentation for the x/group module.
.gitbook/developers/modules/core/mint/README.md Deleted documentation for the minting module.
.gitbook/developers/modules/core/nft/README.md Deleted documentation for the NFT module.
.gitbook/developers/modules/core/params/README.md Deleted documentation for the deprecated Params module.
.gitbook/developers/modules/core/slashing/README.md Deleted documentation for the slashing module.
.gitbook/developers/modules/core/upgrade/README.md Deleted documentation for the upgrade module.
.gitbook/developers/modules/injective/README.md Deleted overview of application logic for the Injective chain.
.gitbook/developers/modules/injective/auction/01_state.md Deleted documentation for auction module state management.
.gitbook/developers/modules/injective/auction/02_messages.md Deleted documentation for auction messages.
.gitbook/developers/modules/injective/auction/03_end_block.md Deleted documentation for auction end-block process.
.gitbook/developers/modules/injective/auction/04_events.md Deleted documentation for auction module events.
.gitbook/developers/modules/injective/auction/05_params.md Deleted documentation for auction module parameters.
.gitbook/developers/modules/injective/auction/README.md Deleted overview of auction module functionality.
.gitbook/developers/modules/injective/exchange/00_derivative_market_concepts.md Deleted documentation on derivative market concepts.
.gitbook/developers/modules/injective/exchange/01_spot_market_concepts.md Deleted documentation on spot market concepts.
.gitbook/developers/modules/injective/exchange/02_binary_options_markets.md Deleted documentation on binary options markets.
.gitbook/developers/modules/injective/exchange/02_other_concepts.md Deleted documentation on other market concepts.
.gitbook/developers/modules/injective/exchange/03_state.md Deleted state management documentation for exchange module.
.gitbook/developers/modules/injective/exchange/04_state_transitions.md Deleted documentation for exchange module state transitions.
.gitbook/developers/modules/injective/exchange/05_messages.md Deleted documentation for exchange messages.
.gitbook/developers/modules/injective/exchange/06_proposals.md Deleted documentation for exchange governance proposals.
.gitbook/developers/modules/injective/exchange/07_begin_block.md Deleted documentation for exchange begin-block processes.
.gitbook/developers/modules/injective/exchange/08_end_block.md Deleted documentation for exchange end-block processes.
.gitbook/developers/modules/injective/exchange/09_events.md Deleted documentation for exchange events.
.gitbook/developers/modules/injective/exchange/10_params.md Deleted documentation for exchange parameters.
.gitbook/developers/modules/injective/exchange/11_msg_privileged_execute_contract.md Deleted documentation for privileged contract execution message.
.gitbook/developers/modules/injective/exchange/README.md Deleted overview of exchange module functionality.
.gitbook/developers/modules/injective/insurance/01_state.md Deleted documentation for insurance module state management.
.gitbook/developers/modules/injective/insurance/02_state_transitions.md Deleted documentation for insurance state transitions.
.gitbook/developers/modules/injective/insurance/03_messages.md Deleted documentation for insurance messages.
.gitbook/developers/modules/injective/insurance/04_end_block.md Deleted documentation for insurance end-block processes.
.gitbook/developers/modules/injective/insurance/05_events.md Deleted documentation for insurance events.
.gitbook/developers/modules/injective/insurance/06_params.md Deleted documentation for insurance parameters.
.gitbook/developers/modules/injective/insurance/07_future_improvements.md Deleted future improvements documentation for insurance module.
.gitbook/developers/modules/injective/insurance/README.md Deleted overview of insurance module functionality.
.gitbook/developers/modules/injective/ocr/01_concepts.md Deleted documentation for OCR module concepts.
.gitbook/developers/modules/injective/ocr/02_state.md Deleted state management documentation for OCR module.
.gitbook/developers/modules/injective/ocr/03_messages.md Deleted documentation for OCR messages.
.gitbook/developers/modules/injective/ocr/04_proposals.md Deleted documentation for OCR governance proposals.
.gitbook/developers/modules/injective/ocr/05_begin_block.md Deleted documentation for OCR begin-block processes.
.gitbook/developers/modules/injective/ocr/06_hooks.md Deleted documentation for OCR hooks.
.gitbook/developers/modules/injective/ocr/07_events.md Deleted documentation for OCR events.
.gitbook/developers/modules/injective/ocr/08_params.md Deleted documentation for OCR parameters.
.gitbook/developers/modules/injective/ocr/README.md Deleted overview of OCR module functionality.
.gitbook/developers/modules/injective/peggy/01_definitions.md Deleted documentation for Peggy system definitions.
.gitbook/developers/modules/injective/peggy/02_workflow.md Deleted documentation for Peggy workflow.
.gitbook/developers/modules/injective/peggy/03_state.md Deleted state management documentation for Peggy module.
.gitbook/developers/modules/injective/peggy/04_messages.md Deleted documentation for Peggy messages.
.gitbook/developers/modules/injective/peggy/05_slashing.md Deleted documentation for Peggy slashing conditions.
.gitbook/developers/modules/injective/peggy/06_end_block.md Deleted documentation for Peggy end-block processes.
.gitbook/developers/modules/injective/peggy/07_events.md Deleted documentation for Peggy events.
.gitbook/developers/modules/injective/peggy/08_params.md Deleted documentation for Peggy parameters.

Possibly related PRs

  • feat: Add notes about testnet proposal submission #8: The changes in this PR relate to the process of submitting proposals on the testnet, which may involve similar governance and proposal submission processes as outlined in the main PR's documentation deletions.

Poem

In the fields where rabbits play,
Documentation's gone away.
With every file, a tale untold,
Of Injective's dreams, now lost, behold!
But hop we will, through code and lore,
For new adventures wait in store! 🐇✨


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant