Skip to content

Conversation

@aralyekta
Copy link
Collaborator

@aralyekta aralyekta commented Oct 13, 2025

Add action docs

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Actions guide covering capabilities, execution flow, setup, testing, management, and current limitations, with examples and visuals.
    • Updated images in the Audit Logs and Excel Extraction guides for consistency and reliability.
    • Updated site navigation to include the new Actions guide.

@coderabbitai
Copy link

coderabbitai bot commented Oct 13, 2025

Walkthrough

Adds a new Actions guide page, updates image asset paths in two existing guides, and updates navigation to include the new page. No code or API changes; all modifications are documentation and configuration.

Changes

Cohort / File(s) Summary
New Actions guide
`guides/actions.mdx`
Adds a comprehensive Actions feature guide covering execution flow, creation steps, configuration, testing, usage, management, and examples; notes only “API Call” type is implemented.
Image path migrations
`guides/audit-logs.mdx`, `guides/excel-extraction.mdx`
Updates image sources to new paths under `/images/guides/...`; no content or structural changes.
Navigation update
`mint.json`
Adds `"guides/actions"` to Guides pages; adjusts trailing comma after `"guides/audit-logs"`.

Sequence Diagram(s)

sequenceDiagram
    actor User
    participant Guru
    participant ActionEngine as Action Engine
    participant API as External API

    User->>Guru: Ask question
    Guru->>ActionEngine: Evaluate Condition Prompt
    ActionEngine->>ActionEngine: Extract Parameters
    ActionEngine-->>Guru: Execution decision (invoke / skip)
    alt Invoke
        ActionEngine->>API: HTTP request (method, URL, headers, body)
        API-->>ActionEngine: Response
        ActionEngine-->>Guru: Usage Prompt with results
        Guru-->>User: Answer with action output
    else Skip
        Guru-->>User: Answer without action
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title 'Task/actions' is non-descriptive and resembles a branch identifier rather than summarizing the main change of adding new documentation for the Actions feature, so it fails to provide clear context for the pull request. Rename the title to a concise, descriptive sentence such as 'Add documentation for the Actions feature' to clearly communicate the primary purpose of this pull request.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 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 865b287 and 04da58c.

⛔ Files ignored due to path filters (26)
  • images/guides/actions/created.png is excluded by !**/*.png
  • images/guides/actions/empty.png is excluded by !**/*.png
  • images/guides/actions/options.png is excluded by !**/*.png
  • images/guides/actions/reference.png is excluded by !**/*.png
  • images/guides/actions/stage1-1.png is excluded by !**/*.png
  • images/guides/actions/stage1-2.png is excluded by !**/*.png
  • images/guides/actions/stage2-1.png is excluded by !**/*.png
  • images/guides/actions/stage2-2.png is excluded by !**/*.png
  • images/guides/actions/stage2-3.png is excluded by !**/*.png
  • images/guides/audit-logs/audit-logs.png is excluded by !**/*.png
  • images/guides/audit-logs/before-after.png is excluded by !**/*.png
  • images/guides/audit-logs/info.png is excluded by !**/*.png
  • images/guides/excel-extraction/1-bad.png is excluded by !**/*.png
  • images/guides/excel-extraction/1-good.png is excluded by !**/*.png
  • images/guides/excel-extraction/2-bad.png is excluded by !**/*.png
  • images/guides/excel-extraction/2-good.png is excluded by !**/*.png
  • images/guides/excel-extraction/2-sub-table.png is excluded by !**/*.png
  • images/guides/excel-extraction/3-bad.png is excluded by !**/*.png
  • images/guides/excel-extraction/3-good.png is excluded by !**/*.png
  • images/guides/excel-extraction/5-bad.png is excluded by !**/*.png
  • images/guides/excel-extraction/5-good.png is excluded by !**/*.png
  • images/guides/excel-extraction/6-bad-fixed.png is excluded by !**/*.png
  • images/guides/excel-extraction/6-bad.png is excluded by !**/*.png
  • images/guides/excel-extraction/6-good-more-complex.png is excluded by !**/*.png
  • images/guides/excel-extraction/6-good.png is excluded by !**/*.png
  • images/guides/excel-extraction/7-good.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • guides/actions.mdx (1 hunks)
  • guides/audit-logs.mdx (3 hunks)
  • guides/excel-extraction.mdx (7 hunks)
  • mint.json (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.mdx: Use MDX format for all documentation files
Use Mintlify components like , , for rich content
Include practical examples and code snippets in documentation
Use images from /images/ directory for visual guides

Files:

  • guides/excel-extraction.mdx
  • guides/audit-logs.mdx
  • guides/actions.mdx
mint.json

📄 CodeRabbit inference engine (CLAUDE.md)

mint.json: Navigation structure is defined in mint.json under the navigation key
mint.json contains all site configuration, navigation, and settings

Files:

  • mint.json
🧠 Learnings (1)
📚 Learning: 2025-07-19T21:27:14.098Z
Learnt from: CR
PR: Gurubase/gurubase-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-19T21:27:14.098Z
Learning: Applies to mint.json : Navigation structure is defined in mint.json under the navigation key

Applied to files:

  • mint.json
🔇 Additional comments (1)
guides/actions.mdx (1)

32-211: Verify referenced action screenshots exist

The guide embeds 9 images under /images/guides/actions/…, but the PR doesn’t add those assets. Please double‑check that each file exists (case‑sensitive paths) so the page doesn’t render broken placeholders.


Comment @coderabbitai help to get the list of available commands and usage tips.

@fatihbaltaci fatihbaltaci merged commit 53d7d22 into master Oct 14, 2025
2 of 3 checks passed
@fatihbaltaci fatihbaltaci deleted the task/actions branch October 14, 2025 18:35
@coderabbitai coderabbitai bot mentioned this pull request Nov 25, 2025
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.

3 participants