Skip to content

Conversation

@k3dz0r
Copy link
Collaborator

@k3dz0r k3dz0r commented Feb 14, 2025

Marketplace
The Upload guide was split into two (TGWUI and ComfyUI). Testnet Limitations and the Login guide were fixed for Polygon mainnet.

CLI
Removed backslashes from all commands.

Summary by CodeRabbit

  • Documentation
    • Enhanced CLI command syntax across multiple commands to improve readability by removing line continuation characters.
    • Updated instructions and examples for offers, orders, tokens, workflows, and solutions to clarify usage.
    • Revised blockchain connection details in guides with new endpoint information.
    • Introduced dedicated guides for uploading models using both TGWUI and ComfyUI.
    • Improved navigation by updating sidebar positions and content ordering across relevant documentation.

Removed backslashes from all commands.

Marketplace

The Upload guide was split into two (TGWUI and ComfyUI). Testnet Limitations and the Login guide were fixed for Polygon mainnet.
@AManilov AManilov merged commit 3cdab8d into develop Feb 14, 2025
4 checks passed
@coderabbitai
Copy link

coderabbitai bot commented Feb 14, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request updates several documentation files to improve readability and consistency in command syntax examples. Most modifications involve the removal of backslashes, line breaks, and other continuation characters, resulting in a more compact and uniform presentation. Additionally, configuration values for blockchain settings have been updated and several marketplace guides have been refined with more specific instructions for model uploads and network guidance.

Changes

File(s) Change Summary
docs/cli/commands/index.md Removed guidance on using backslashes for long command lines in the general CLI documentation.
docs/cli/commands/files/{delete, download, upload}.md Reformatted file commands by removing backslashes and unnecessary line breaks.
docs/cli/commands/offers/* Removed backslashes, leading dots, and line continuations from offers commands to enhance syntax clarity.
docs/cli/commands/orders/* Simplified orders command syntax by eliminating backslashes and consolidating command lines.
docs/cli/commands/providers/* Updated provider commands by removing backslashes for a consistent command format.
docs/cli/commands/{quotes/validate, solutions/{generate-key,prepare}}.md Adjusted command examples in quotes and solutions sections by modifying backslash placement and line breaks.
docs/cli/commands/tokens/{balance, request}.md Removed line continuation characters and clarified the --matic option in token commands.
docs/cli/commands/workflows/{create, generate-key}.md Reformatted workflows commands by removing hyphen prefixes and backslashes.
docs/developers/cli_guides/assets/config.json Updated blockchain configuration parameters (rpcUrl and smartContractAddress) to new endpoint values.
docs/developers/cli_guides/providers_offers.md Simplified provider account creation instructions and removed explicit references to prior network setups.
docs/fundamentals/{orders.md, slots.md} Adjusted sidebar positions to change the order of navigation items.
docs/marketplace/guides/* Revised marketplace guides: added specific model upload instructions, updated network details, and modified storage key permissions.
docs/marketplace/limitations.md Modified phrasing and updated token distribution details in the limitations document.
docs/marketplace/my-content/my-files/{index.md, upload-content.md} Updated content instructions to reference separate guides for TGWUI and ComfyUI model uploads.

Suggested reviewers

  • AManilov

Poem

I’m just a bunny hopping by,
Admiring docs that now fly high.
Backslashes gone, syntax so neat,
Lines reformed with a rhythmic beat.
In fields of code, I celebrate —
A little cheer from a rabbit’s fate!
🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 51a6ee1 and c3719c8.

⛔ Files ignored due to path filters (9)
  • docs/marketplace/images/hf-safetensors-duplicates.png is excluded by !**/*.png
  • docs/marketplace/images/hf-task.png is excluded by !**/*.png
  • docs/marketplace/images/hf-text-generation.png is excluded by !**/*.png
  • docs/marketplace/images/hf-text-to-image.png is excluded by !**/*.png
  • docs/marketplace/images/metamask-polygon-add.png is excluded by !**/*.png
  • docs/marketplace/images/metamask-testnet-add.png is excluded by !**/*.png
  • docs/marketplace/images/metamask-testnet-form.png is excluded by !**/*.png
  • docs/marketplace/images/metamask-testnet-switch.png is excluded by !**/*.png
  • docs/marketplace/images/web3acc-teepol.png is excluded by !**/*.png
📒 Files selected for processing (45)
  • docs/cli/commands/files/delete.md (1 hunks)
  • docs/cli/commands/files/download.md (1 hunks)
  • docs/cli/commands/files/upload.md (1 hunks)
  • docs/cli/commands/index.md (1 hunks)
  • docs/cli/commands/offers/add-slot.md (1 hunks)
  • docs/cli/commands/offers/delete-slot.md (1 hunks)
  • docs/cli/commands/offers/disable.md (1 hunks)
  • docs/cli/commands/offers/download-content.md (1 hunks)
  • docs/cli/commands/offers/enable.md (1 hunks)
  • docs/cli/commands/offers/get-info.md (1 hunks)
  • docs/cli/commands/offers/get-option.md (1 hunks)
  • docs/cli/commands/offers/get-slot.md (1 hunks)
  • docs/cli/commands/offers/get.md (1 hunks)
  • docs/cli/commands/offers/list.md (1 hunks)
  • docs/cli/commands/offers/update-slot.md (1 hunks)
  • docs/cli/commands/offers/update.md (1 hunks)
  • docs/cli/commands/orders/cancel.md (1 hunks)
  • docs/cli/commands/orders/download-result.md (1 hunks)
  • docs/cli/commands/orders/get.md (1 hunks)
  • docs/cli/commands/orders/list.md (1 hunks)
  • docs/cli/commands/orders/replenish-deposit.md (1 hunks)
  • docs/cli/commands/providers/get.md (1 hunks)
  • docs/cli/commands/providers/list.md (1 hunks)
  • docs/cli/commands/providers/update.md (1 hunks)
  • docs/cli/commands/quotes/validate.md (1 hunks)
  • docs/cli/commands/solutions/generate-key.md (1 hunks)
  • docs/cli/commands/solutions/prepare.md (1 hunks)
  • docs/cli/commands/tokens/balance.md (1 hunks)
  • docs/cli/commands/tokens/request.md (2 hunks)
  • docs/cli/commands/workflows/create.md (1 hunks)
  • docs/cli/commands/workflows/generate-key.md (1 hunks)
  • docs/cli/index.md (2 hunks)
  • docs/developers/cli_guides/assets/config.json (1 hunks)
  • docs/developers/cli_guides/providers_offers.md (1 hunks)
  • docs/fundamentals/orders.md (1 hunks)
  • docs/fundamentals/slots.md (1 hunks)
  • docs/marketplace/guides/index.md (1 hunks)
  • docs/marketplace/guides/log-in.md (2 hunks)
  • docs/marketplace/guides/place-order.md (1 hunks)
  • docs/marketplace/guides/storage.md (3 hunks)
  • docs/marketplace/guides/upload-comfyui.md (1 hunks)
  • docs/marketplace/guides/upload-tgwui.md (6 hunks)
  • docs/marketplace/limitations.md (2 hunks)
  • docs/marketplace/my-content/my-files/index.md (1 hunks)
  • docs/marketplace/my-content/my-files/upload-content.md (1 hunks)

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

2 participants