Documentation edits made through Mintlify web editor#64
Conversation
📝 WalkthroughWalkthroughReorganizes site navigation in Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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 | 🔴 CriticalFix 265+ broken API documentation links and correct connector naming.
The navigation references 265+conductorone-api/*pages that don't exist (onlyapi.mdx,authenticate.mdx, andpagination.mdxexist). Additionally,baton/panda-docshould bebaton/pandadocto match the actual file atbaton/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.
- 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>
There was a problem hiding this comment.
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 | 🟠 MajorAdd 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.
Added schedule for app user and schedule for user trigger references; made standalone pages for triggers and steps
Summary by CodeRabbit