Skip to content

Documentation edits made through Mintlify web editor#64

Open
rtfc1 wants to merge 8 commits intomainfrom
automations-trigger-steps-references
Open

Documentation edits made through Mintlify web editor#64
rtfc1 wants to merge 8 commits intomainfrom
automations-trigger-steps-references

Conversation

@rtfc1
Copy link

@rtfc1 rtfc1 commented Feb 5, 2026

Added schedule for app user and schedule for user trigger references; made standalone pages for triggers and steps

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Automations references: new Triggers and Steps pages with examples, fields, behavior notes and early-access guidance; reorganized main Automations guide into clearer step-by-step flows.
    • Restructured navigation across docs: removed select how-to and Directory pages; simplified Developer section; reorganized Connectors groups and Connector Library; moved Integration pages under Platform; consolidated CEL expressions.
    • API docs: replaced prior openapi reference with a detailed, grouped Endpoints pages structure and removed an obsolete redirect.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 5, 2026

📝 Walkthrough

Walkthrough

Reorganizes site navigation in docs.json (many group renames, page moves, and removals), removes a legacy redirect, adds two new automation reference pages, and substantially rewrites the Automations guide (metadata, structure, and copy).

Changes

Cohort / File(s) Summary
Top-level navigation & redirects
docs.json
Major navigation restructuring: connector group renames and page relocations; removal of nested Integrations group; Platform and Developer nav reshuffled; CEL expressions trimmed; API endpoints replaced by grouped Pages; removed legacy redirect /developer/sql-authoring.
Automation reference pages
product/admin/automations-triggers-reference.mdx, product/admin/automations-steps-reference.mdx
Added two new MDX reference pages documenting all automation triggers and automation steps (fields, examples, notes). "Call function" step marked early access.
Automations guide
product/admin/automations.mdx
Comprehensive rewrite: frontmatter/metadata quoting standardized, editor timestamp updated, flow converted into explicit numbered Step blocks, links updated to new reference pages, images replaced with inline assets, and numerous sections condensed or reworded.
Directory cleanup
removed/relocated pages referenced in docs.json (e.g., product/how-to/request-actions, product/admin/groups, various baton/* pages)
Several pages removed from their previous groups or relocated to new top-level/renamed groups per the navigation changes; connector lists updated (additions/removals/renames).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐇 I nudged the menus, shuffled maps with care,
New triggers twitch, new steps hop through the air,
Pages found new burrows, old paths laid to rest,
A cleaner trail for readers — tidy nest. 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and does not clearly indicate the specific changes made. 'Documentation edits made through Mintlify web editor' describes the tool/method used rather than the substantive content changes (new automation triggers/steps documentation). Use a more specific title that describes the actual changes, such as 'Add automation triggers and steps reference documentation' or 'Create trigger and step reference guides for automations'.
✅ 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 changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch automations-trigger-steps-references

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs.json (1)

137-451: ⚠️ Potential issue | 🔴 Critical

Fix 265+ broken API documentation links and correct connector naming.
The navigation references 265+ conductorone-api/* pages that don't exist (only api.mdx, authenticate.mdx, and pagination.mdx exist). Additionally, baton/panda-doc should be baton/pandadoc to match the actual file at baton/pandadoc.mdx.

🤖 Fix all issues with AI agents
In `@product/admin/automations-steps-reference.mdx`:
- Around line 1-4: Update the frontmatter description in the "Automation steps
reference" page to focus on step-specific capabilities rather than triggers:
replace the sentence mentioning "event-based, scheduled, and on-demand options"
with a concise description that emphasizes the catalog of available automation
steps, their inputs/outputs, and usage examples (edit the description field in
the frontmatter at the top of the file to reflect step-focused content).

In `@product/admin/automations.mdx`:
- Around line 175-179: Remove the stray empty Markdown heading inside the Frame
by deleting the lone "##" line so the Frame no longer contains an empty heading;
locate the Frame block that contains the image reference and the subsequent "##"
and remove that "##" token (or replace it with appropriate content if a heading
was intended) to clean up the rendering.
- Around line 50-58: Update the two in-page anchor links that point to removed
anchors: replace the "[automation triggers
reference](/product/admin/automations#automation-triggers-reference)" link with
the new standalone triggers page (e.g., "/product/admin/automation-triggers")
and replace the "[automation steps
reference](/product/admin/automations#automation-steps-reference)" link with the
new standalone steps page (e.g., "/product/admin/automation-steps"); locate
these link texts in the automations.mdx content and update their hrefs to the
correct new routes, then verify the links resolve and adjust if the actual new
slug differs.

mindymo and others added 2 commits February 5, 2026 15:57
- Remove backslash escaping from navigation paths (Admin > Automations)
- Add missing end-of-file newlines to reference files
- Update Editor Refresh date to current date
- Remove malformed empty heading from Frame component

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Convert all trigger and step headings from Title Case to sentence case
per docs style guide. Proper nouns (e.g., Slack) remain capitalized.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Change from third person ("This trigger activates...") to direct
  address ("Use this trigger to...")
- Remove editorializing language ("essential", "valuable", "seamless")
- Use contractions naturally per style guide
- Start descriptions with action verbs
- Address reader directly with "you" throughout

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Break out optional fields from required fields for better scannability:
- Required fields: lists only mandatory fields
- Optional fields: lists configurable extras

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs.json (1)

444-452: ⚠️ Potential issue | 🟠 Major

Add missing Developer pages to docs.json and fix broken terraform reference.

The Developer section is missing 17 documentation files that exist in the repository:

  • baton-sdk.mdx, build-connector.mdx, c1-api.mdx, cel-expressions.mdx, community.mdx, concepts.mdx, config-schema.mdx, debugging.mdx, error-codes.mdx, glossary.mdx, http-authoring.mdx, pagination.mdx, provisioning.mdx, recipes-auth.mdx, recipes-caching.mdx, recipes-id.mdx, recipes-testing.mdx

Additionally, docs.json references a non-existent "developer/terraform" page that has no corresponding .mdx file in the repository. Either remove the terraform entry or add the missing file. Clarify if the remaining 17 pages should be added to navigation, deleted from the repository, or handled via redirects.

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