Skip to content

A bunch more improvements to the documentation :) #344

Merged
rb0000 merged 3 commits intomainfrom
rb/better
Mar 13, 2026
Merged

A bunch more improvements to the documentation :) #344
rb0000 merged 3 commits intomainfrom
rb/better

Conversation

@rb0000
Copy link
Contributor

@rb0000 rb0000 commented Mar 13, 2026

Added "Coming Soon" sections across 7 documentation pages for undocumented features (HITL enforcement, conditional rules, rate limiting, eval gates, version control, security controls, registries)
Documented existing action justifications feature in
monitoring.mdx
Added MCP servers hyperlink to
custom-names-descriptions.mdx
Updated
introduction.mdx
to reflect current product positioning
Minor wording updates (4-eyes → version control workflows, quality → evaluation standards)

Ria Balli added 2 commits March 13, 2026 15:59
@rb0000 rb0000 merged commit ef13482 into main Mar 13, 2026
5 checks passed
@rb0000 rb0000 deleted the rb/better branch March 13, 2026 20:06
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 13, 2026

Greptile Summary

This PR makes a broad sweep of documentation improvements: it rewrites introduction.mdx to reflect current product positioning, fills out several previously stub-only pages (monitoring.mdx, custom-names-descriptions.mdx), adds "Coming Soon" sections across 7 pages to surface the product roadmap, and adds a dry-run testing section to agent-testing.mdx. The changes are generally well-written and consistent in tone.

Key issues found:

  • Broken email link (introduction.mdx line 91): The support@credal.ai address was changed from a clickable mailto: hyperlink to plain bold text. Every other support email reference in the codebase uses the linked form; this is a user-visible regression on the primary entry-point page.
  • Removed internal hyperlinks (introduction.mdx lines 83–84): The Security section previously linked "audit logs" to /user-guide/platform/administration/audit-log-data-exports and "SSO and SCIM" to /user-guide/platform/administration/single-sign-on-sso. Both links were dropped in this rewrite.
  • Absolute URL for internal link (custom-names-descriptions.mdx line 36): The MCP servers cross-link uses https://docs.credal.ai/user-guide/platform/mcp-servers/overview — the only hardcoded domain URL in the entire docs site. All other internal links use root-relative paths and this will break in preview/staging environments.
  • Contradictory messaging (setting-up-controls.mdx): The Note's "coming soon" framing for enforcing human approval on MCP server actions conflicts with the opening paragraph that describes human approval as an existing capability. A clarification on the distinction (e.g., bulk/automatic enforcement vs. per-action configuration) would avoid reader confusion.

Confidence Score: 3/5

  • Safe to merge after fixing the broken mailto link and absolute internal URL — both are user-visible regressions on high-traffic pages.
  • The bulk of the changes are additive documentation (Coming Soon sections, new pages, content rewrites) and carry no behavioral risk. However, two concrete regressions were introduced on introduction.mdx — the removal of the clickable mailto link and two internal cross-links — and custom-names-descriptions.mdx uses a hardcoded domain URL that will silently break in non-production environments. These are straightforward fixes but affect the primary entry-point page and a brand-new page, warranting attention before merge.
  • fern/docs/pages/introduction.mdx (broken mailto link + removed cross-links) and fern/docs/pages/platform/actions/custom-names-descriptions.mdx (absolute internal URL).

Important Files Changed

Filename Overview
fern/docs/pages/introduction.mdx Significant rewrite of the introduction page with updated product positioning; the support email lost its mailto: hyperlink (regression), and two internal cross-links (audit logs, SSO/SCIM) were removed from the Security section.
fern/docs/pages/platform/actions/custom-names-descriptions.mdx New page documenting custom action names/descriptions; contains one absolute URL (https://docs.credal.ai/...) for an internal link, inconsistent with the rest of the codebase which uses root-relative paths.
fern/docs/pages/platform/mcp-servers/import-server/setting-up-controls.mdx Adds a Note about upcoming tool-syncing and human approval features; the "coming soon" wording for human approval enforcement may confuse readers given the page already describes human approval as available.
fern/docs/pages/platform/actions/monitoring.mdx Previously a stub; now fully documents the monitoring dashboard, including action invocations, success rates, justifications, and access steps. No issues found.
fern/docs/pages/platform/agents/deployment/overview.mdx Adds an extensive "Coming Soon" section covering version control, sensitive agents, hallucination/risk detection, delegation controls, and prompt injection prevention. No issues found.
Prompt To Fix All With AI
This is a comment left during a code review.
Path: fern/docs/pages/introduction.mdx
Line: 91

Comment:
**Broken email link (mailto removed)**

The `support@credal.ai` address was changed from a clickable `mailto:` hyperlink to plain bold text, making it impossible for users to click and open their email client. Every other support email in the codebase (including `quickstart.mdx`) uses the linked form.

```suggestion
Questions or need help? Reach out at **[support@credal.ai](mailto:support@credal.ai)**.
```

How can I resolve this? If you propose a fix, please make it concise.

---

This is a comment left during a code review.
Path: fern/docs/pages/introduction.mdx
Line: 83-84

Comment:
**Internal hyperlinks removed from Security section**

Two useful cross-links that were present in the previous version of this section were dropped in this PR:

- `detailed audit logs` previously linked to `/user-guide/platform/administration/audit-log-data-exports`
- `SSO and SCIM integration` previously linked to `/user-guide/platform/administration/single-sign-on-sso`

Restoring these helps users navigate to the relevant feature pages directly from the introduction, which is a common entry point. Consider adding them back:

```suggestion
- Supports human-in-the-loop approval flows and detailed [audit logs](/user-guide/platform/administration/audit-log-data-exports)
- Flexible deployment: cloud or on-prem, with [SSO and SCIM](/user-guide/platform/administration/single-sign-on-sso) integration for identity and access management
```

How can I resolve this? If you propose a fix, please make it concise.

---

This is a comment left during a code review.
Path: fern/docs/pages/platform/actions/custom-names-descriptions.mdx
Line: 36

Comment:
**Absolute URL for internal link**

This is the only internal link in the entire docs codebase that uses an absolute `https://docs.credal.ai/...` URL. Every other internal cross-reference uses a root-relative path (e.g., `/user-guide/platform/...`). Using the hardcoded domain will silently break in staging, PR preview, or any environment not served from `docs.credal.ai`.

```suggestion
You can distribute and scale usage of your customized actions in any surface through our [custom MCP servers](/user-guide/platform/mcp-servers/overview). Your HR, Finance, Product, etc. team can then manage their own blessed set of tools for the entire organization to use.
```

How can I resolve this? If you propose a fix, please make it concise.

---

This is a comment left during a code review.
Path: fern/docs/pages/platform/mcp-servers/import-server/setting-up-controls.mdx
Line: 6

Comment:
**Contradictory messaging about human approval availability**

The opening paragraph of this page already states that admins *can* "require human approval before specific actions execute" as a current feature. The new Note, however, ends with "…as well as the ability to enforce human approval on any of these actions" framed as a coming-soon item.

A reader will reasonably interpret this as "human approval on MCP server actions is not yet available," which directly contradicts the sentence above. If the coming-soon item refers specifically to *bulk / automatic* enforcement (as opposed to per-action configuration), the Note should clarify that distinction to avoid confusion.

How can I resolve this? If you propose a fix, please make it concise.

Last reviewed commit: 34351d4

## Support

For questions or support? Reach out to our team at **[support@credal.ai](mailto:support@credal.ai)**.
Questions or need help? Reach out at **support@credal.ai**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Broken email link (mailto removed)

The support@credal.ai address was changed from a clickable mailto: hyperlink to plain bold text, making it impossible for users to click and open their email client. Every other support email in the codebase (including quickstart.mdx) uses the linked form.

Suggested change
Questions or need help? Reach out at **support@credal.ai**.
Questions or need help? Reach out at **[support@credal.ai](mailto:support@credal.ai)**.
Prompt To Fix With AI
This is a comment left during a code review.
Path: fern/docs/pages/introduction.mdx
Line: 91

Comment:
**Broken email link (mailto removed)**

The `support@credal.ai` address was changed from a clickable `mailto:` hyperlink to plain bold text, making it impossible for users to click and open their email client. Every other support email in the codebase (including `quickstart.mdx`) uses the linked form.

```suggestion
Questions or need help? Reach out at **[support@credal.ai](mailto:support@credal.ai)**.
```

How can I resolve this? If you propose a fix, please make it concise.

Comment on lines +83 to +84
- Supports human-in-the-loop approval flows and detailed audit logs
- Flexible deployment: cloud or on-prem, with SSO and SCIM integration for identity and access management
Copy link
Contributor

Choose a reason for hiding this comment

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

Internal hyperlinks removed from Security section

Two useful cross-links that were present in the previous version of this section were dropped in this PR:

  • detailed audit logs previously linked to /user-guide/platform/administration/audit-log-data-exports
  • SSO and SCIM integration previously linked to /user-guide/platform/administration/single-sign-on-sso

Restoring these helps users navigate to the relevant feature pages directly from the introduction, which is a common entry point. Consider adding them back:

Suggested change
- Supports human-in-the-loop approval flows and detailed audit logs
- Flexible deployment: cloud or on-prem, with SSO and SCIM integration for identity and access management
- Supports human-in-the-loop approval flows and detailed [audit logs](/user-guide/platform/administration/audit-log-data-exports)
- Flexible deployment: cloud or on-prem, with [SSO and SCIM](/user-guide/platform/administration/single-sign-on-sso) integration for identity and access management
Prompt To Fix With AI
This is a comment left during a code review.
Path: fern/docs/pages/introduction.mdx
Line: 83-84

Comment:
**Internal hyperlinks removed from Security section**

Two useful cross-links that were present in the previous version of this section were dropped in this PR:

- `detailed audit logs` previously linked to `/user-guide/platform/administration/audit-log-data-exports`
- `SSO and SCIM integration` previously linked to `/user-guide/platform/administration/single-sign-on-sso`

Restoring these helps users navigate to the relevant feature pages directly from the introduction, which is a common entry point. Consider adding them back:

```suggestion
- Supports human-in-the-loop approval flows and detailed [audit logs](/user-guide/platform/administration/audit-log-data-exports)
- Flexible deployment: cloud or on-prem, with [SSO and SCIM](/user-guide/platform/administration/single-sign-on-sso) integration for identity and access management
```

How can I resolve this? If you propose a fix, please make it concise.

Custom names and descriptions only affect how actions appear within Credal. The underlying integration or MCP server functionality remains unchanged.
</Note>

You can distribute and scale usage of your customized actions in any surface through our [custom MCP servers](https://docs.credal.ai/user-guide/platform/mcp-servers/overview). Your HR, Finance, Product, etc. team can then manage their own blessed set of tools for the entire organization to use.
Copy link
Contributor

Choose a reason for hiding this comment

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

Absolute URL for internal link

This is the only internal link in the entire docs codebase that uses an absolute https://docs.credal.ai/... URL. Every other internal cross-reference uses a root-relative path (e.g., /user-guide/platform/...). Using the hardcoded domain will silently break in staging, PR preview, or any environment not served from docs.credal.ai.

Suggested change
You can distribute and scale usage of your customized actions in any surface through our [custom MCP servers](https://docs.credal.ai/user-guide/platform/mcp-servers/overview). Your HR, Finance, Product, etc. team can then manage their own blessed set of tools for the entire organization to use.
You can distribute and scale usage of your customized actions in any surface through our [custom MCP servers](/user-guide/platform/mcp-servers/overview). Your HR, Finance, Product, etc. team can then manage their own blessed set of tools for the entire organization to use.
Prompt To Fix With AI
This is a comment left during a code review.
Path: fern/docs/pages/platform/actions/custom-names-descriptions.mdx
Line: 36

Comment:
**Absolute URL for internal link**

This is the only internal link in the entire docs codebase that uses an absolute `https://docs.credal.ai/...` URL. Every other internal cross-reference uses a root-relative path (e.g., `/user-guide/platform/...`). Using the hardcoded domain will silently break in staging, PR preview, or any environment not served from `docs.credal.ai`.

```suggestion
You can distribute and scale usage of your customized actions in any surface through our [custom MCP servers](/user-guide/platform/mcp-servers/overview). Your HR, Finance, Product, etc. team can then manage their own blessed set of tools for the entire organization to use.
```

How can I resolve this? If you propose a fix, please make it concise.

For every MCP server, admins can enable or disable individual tools and require [human approval](/user-guide/platform/governed-actions/human-approval-options) before specific actions execute. If a third-party server exposes actions that are too sensitive or not relevant for your organization, simply turn them off. For actions you want to allow but monitor closely, approval enforcement ensures nothing runs without a human sign-off first.

<Note>
**Tool Syncing:** Credal automatically refreshes the list of available tools every time `tools/list` is called through the MCP gateway. You can also manually refresh tools using the refresh button in the UI. Background refreshes with version control to synchronously approve changes are coming soon, as well as the ability to enforce human approval on any of these actions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Contradictory messaging about human approval availability

The opening paragraph of this page already states that admins can "require human approval before specific actions execute" as a current feature. The new Note, however, ends with "…as well as the ability to enforce human approval on any of these actions" framed as a coming-soon item.

A reader will reasonably interpret this as "human approval on MCP server actions is not yet available," which directly contradicts the sentence above. If the coming-soon item refers specifically to bulk / automatic enforcement (as opposed to per-action configuration), the Note should clarify that distinction to avoid confusion.

Prompt To Fix With AI
This is a comment left during a code review.
Path: fern/docs/pages/platform/mcp-servers/import-server/setting-up-controls.mdx
Line: 6

Comment:
**Contradictory messaging about human approval availability**

The opening paragraph of this page already states that admins *can* "require human approval before specific actions execute" as a current feature. The new Note, however, ends with "…as well as the ability to enforce human approval on any of these actions" framed as a coming-soon item.

A reader will reasonably interpret this as "human approval on MCP server actions is not yet available," which directly contradicts the sentence above. If the coming-soon item refers specifically to *bulk / automatic* enforcement (as opposed to per-action configuration), the Note should clarify that distinction to avoid confusion.

How can I resolve this? If you propose a fix, please make it concise.

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