Skip to content

Conversation

@0xaaditya
Copy link
Contributor

No description provided.

@gemini-code-assist
Copy link

Summary of Changes

Hello @0xaaditya, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refines and expands the documentation for Gigabrain, an AI-powered market intelligence platform. The changes aim to provide a more coherent and in-depth understanding of the platform's features, including its conversational AI, market intelligence feed, and autonomous trading agents. By removing boilerplate content and introducing detailed, product-centric guides, the update improves the clarity and utility of the documentation for both new and experienced users, as well as developers looking to integrate with the platform's API.

Highlights

  • Documentation Restructuring: The documentation has undergone a significant overhaul, removing generic Mintlify starter kit pages and introducing a more focused, product-specific structure. This includes new 'Getting Started' and 'Guides' sections in the navigation.
  • Enhanced Core Feature Documentation: Detailed explanations for 'Chat', 'Alpha', and 'Agents' have been extensively rewritten and expanded. This provides users with clearer insights into how these core features work, their configurations, monitoring, best practices, and limitations.
  • Introduction of Brain API Overview: A new comprehensive 'Brain API Overview' has been added, detailing programmatic access to Gigabrain's 'Intelligence Collective'. It outlines specialized agents, available data types, and provides structured JSON response examples for developers.
  • Updated API and Developer Guides: The developer introduction now emphasizes structured JSON responses, includes detailed response formats, response times, and updated code examples for Python and JavaScript, enhancing clarity for API integrators.
  • Expanded FAQ Section: The Frequently Asked Questions (FAQ) section has been substantially expanded to address a wider range of user queries, covering topics from Gigabrain's core functionality and accuracy to pricing, integrations, and developer resources.
  • New Pricing and Integrations Guides: Dedicated pages for 'Pricing' and 'Integrations' have been introduced. The pricing guide details pay-as-you-go and token-gated access models, while the integrations guide explains how to connect platforms like Hyperliquid and Telegram.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • README.md
    • Updated the main title to 'Gigabrain Docs' and added a product description.
    • Simplified local development and publishing instructions.
    • Introduced a 'Project Structure' section.
  • api-reference/endpoint/create.mdx
    • Removed file.
  • api-reference/endpoint/delete.mdx
    • Removed file.
  • api-reference/endpoint/get.mdx
    • Removed file.
  • api-reference/endpoint/webhook.mdx
    • Removed file.
  • api-reference/introduction.mdx
    • Removed file.
  • api-reference/openapi.json
    • Removed file.
  • core-features/agents.mdx
    • Rewrote content to provide a comprehensive guide on autonomous trading agents, including their mechanics, configuration, monitoring, example strategies, best practices, troubleshooting, and limitations.
  • core-features/alpha.mdx
    • Rewrote content to detail Alpha's market intelligence system, covering its monitoring capabilities, information sources, synthesis process, insight format, and 'Suggest Trade' feature.
  • core-features/chat.mdx
    • Revised extensively to explain Gigabrain Chat's functionality, query types (trading, fundamentals, macro, etc.), exchange integrations for direct trade execution, best practices, and its capabilities versus limitations.
  • developers/brain-api-overview.mdx
    • Added new file detailing the Gigabrain API, specialized agents, data categories, and JSON response examples.
  • developers/introduction.mdx
    • Updated to highlight support for structured JSON responses.
    • Modified API response examples to use 'content' field instead of 'message'.
    • Added information on API response times and a 504 Gateway Timeout status code.
    • Updated Python and JavaScript code examples to demonstrate JSON parsing and include request timeouts.
    • Revised best practices to include setting timeouts and using JSON for automation.
  • development.mdx
    • Removed file.
  • docs.json
    • Changed CSS file reference from 'styles.css' to 'style.css'.
    • Restructured navigation: 'About' group renamed to 'Getting Started', 'Core Features & Interface' to 'Core Features'.
    • Added new 'Guides' group with 'agents-setup' and 'integrations' pages.
    • Included 'quickstart' and 'pricing' pages in 'Getting Started'.
    • Removed 'support/agents-guide' and added 'developers/brain-api-overview' to navigation.
  • essentials/code.mdx
    • Removed file.
  • essentials/images.mdx
    • Removed file.
  • essentials/markdown.mdx
    • Removed file.
  • essentials/navigation.mdx
    • Removed file.
  • essentials/reusable-snippets.mdx
    • Removed file.
  • essentials/settings.mdx
    • Removed file.
  • guides/agents-setup.mdx
    • Renamed from 'support/agents-guide.mdx'.
    • Simplified content, focusing on setup steps and removing monitoring details (now covered in 'core-features/agents.mdx').
  • guides/integrations.mdx
    • Added new file detailing how to connect Hyperliquid and Telegram for trade execution and notifications.
  • index.mdx
    • Updated 'The Intelligence Collective' section with a card-based layout for each analyst.
    • Added a new section 'Beyond the Agents' listing various data categories available.
    • Included a note about structured JSON responses and a link to the Brain API Overview.
  • legal/terms-and-conditions.mdx
    • Updated internal links to Privacy Policy and Risk Disclosure.
    • Corrected numbering for several sections and updated email format for support.
  • pricing.mdx
    • Added new file outlining Gigabrain's pay-as-you-go and token-gated access models, including feature comparisons and getting started instructions.
  • quickstart.mdx
    • Rewrote content to guide users through initial Gigabrain setup (account, chat, alpha, agents).
    • Updated 'What's next?' section with links to relevant new/updated documentation.
    • Added a warning regarding financial advice.
  • snippets/snippet-intro.mdx
    • Removed file.
  • support/faqs.mdx
    • Significantly expanded with numerous new questions and answers covering Gigabrain's features, comparisons to other AI, trading, agents, pricing, developer resources, and disclaimers.
    • Added a section for further questions with a Telegram link.
  • support/risk-disclosure.mdx
    • Updated contact email format for support.
Activity
  • The author, 0xaaditya, has performed a major content refresh and structural reorganization of the documentation.
  • Generic starter kit documentation files have been removed, indicating a move towards a fully customized and product-specific documentation set for Gigabrain.
  • New documentation for core features like Agents, Alpha, and Chat has been introduced or heavily revised to provide more detailed and actionable information.
  • A new 'Brain API Overview' has been added, providing comprehensive API documentation for developers.
  • The navigation structure in docs.json has been updated to reflect the new content and organization, improving discoverability of information.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request is a major overhaul of the documentation, migrating from a generic starter kit to a product-specific documentation for Gigabrain. The changes are extensive and significantly improve the quality, detail, and structure of the documentation. Many new pages have been added for core features, pricing, and developer APIs, and existing pages have been greatly expanded. The use of components like CardGroup, Tabs, and Accordion enhances readability. I've identified a few broken links and minor typos/formatting issues that should be addressed, but overall this is an excellent update.

}
```

Parse the `content` field to access the structured data. See the [Brain API Overview](/guides/structured-data) for all available query patterns and data types.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This link to /guides/structured-data appears to be broken as the file does not exist. Based on the context and file structure, it should probably point to /developers/brain-api-overview.

Parse the `content` field to access the structured data. See the [Brain API Overview](/developers/brain-api-overview) for all available query patterns and data types.


- Add "Respond as JSON" to queries for parseable responses
- Specify exact fields for consistent data structures
- See [Brain API Overview](/guides/structured-data) for query patterns

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This link to /guides/structured-data appears to be broken. It should likely point to /developers/brain-api-overview to be consistent with the new file structure and other links.

   - See [Brain API Overview](/developers/brain-api-overview) for query patterns

- **Price Movement Analyst**: Performs technical analysis on price action, including EMAs, SMAs, momentum indicators, volume profiles, and key support/resistance zones to spot patterns and trends.
- **Trenches Analyst**: Specializes in micro cap tokens (under $100M market cap), leveraging social intelligence and narratives analysis, sentiment, and low liquidity risks.
- **Polymarket Analyst**: Analyzes prediction markets for odds, volume, and resolutions across crypto, politics, and events to gauge probabilistic outcomes.
All data types support **structured JSON responses** when explicitly requested, making Gigabrain ideal for building trading bots, dashboards, and data pipelines. See the [Brain API Overview](/guides/brain-api-overview) for details.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This link to /guides/brain-api-overview appears to be broken. Based on the file structure, it should point to /developers/brain-api-overview.

All data types support **structured JSON responses** when explicitly requested, making Gigabrain ideal for building trading bots, dashboards, and data pipelines. See the [Brain API Overview](/developers/brain-api-overview) for details.

5. **Record outcome**: Log the reasoning, actions taken, and market state to the Learnings database

#### 2. The Alpha Sniper (Asset-Agnostic)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's an unnecessary blank line here. Removing it will improve the formatting consistency of the document.

Comment on lines 6 to 7

Gigabrain Chat is the conversational access to of the platform, enabling real-time market queries via natural language. It routes inputs to the Intelligence Collective, a team of specialized agents for parallel analysis, fetching live data from sources like prices, order books, onchain metrics, news, and sentiment. Responses synthesize insights with clear theses, risks, and invalidations, drawing from our four pillars for objective, trader-grade outputs. Chat supports iterative follow ups with session memory, allowing you to refine queries like a live trading desk conversation.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There are a couple of extra blank lines here before the image. Removing them will make the layout cleaner and more consistent with other pages.


### Microstructure Analyst

Perpetual futures dynamics the leverage and positioning layer.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Adding a colon after 'dynamics' would improve the readability of this sentence by clearly separating the topic from its description.

Perpetual futures dynamics: the leverage and positioning layer.

<Step title="Visit integrations page">
1. Go to [Profile → Integrations](https://gigabrain.gg/profile?tab=integrations).
2. Select **Hyperliquid**.
3. Connect your wallet and sign transactions to authorize generate apis wallet to trade on your behalf.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase 'authorize generate apis wallet' is grammatically incorrect and a bit unclear. I suggest rephrasing for clarity.

    3. Connect your wallet and sign transactions to authorize a generated API wallet to trade on your behalf.

Comment on lines +25 to +26
Yes. You can explore Alpha Feed and for chat access and agents access you will
need API credits

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This sentence is a bit clunky and could be clearer. I suggest rephrasing it to improve readability.

  Yes. You can explore the Alpha Feed for free. For Chat and Agents access, you will need to purchase API credits.

</Accordion>

<Accordion title="Can Gigabrain withdraw funds from my exchange?">
No. APIs wallets used for trade execution does not have withdrawal

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a typo here. 'APIs wallets' should be 'API wallets'.

  No. API wallets used for trade execution do not have withdrawal


</AccordionGroup>
<Accordion title="Do API credits expire?">
API Credits purchased has expiry date of 1 year.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The grammar in this sentence could be improved for clarity. I suggest a rephrase.

  Purchased API credits have an expiry date of 1 year.

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