Skip to content

Launch v3 docs (abhishek → main)#232

Open
abhishekjd wants to merge 218 commits into
mainfrom
abhishek
Open

Launch v3 docs (abhishek → main)#232
abhishekjd wants to merge 218 commits into
mainfrom
abhishek

Conversation

@abhishekjd

Copy link
Copy Markdown
Collaborator

Summary

Launches the v3 documentation to main. v3 is added as a non-default version — v2 remains the default version customers see; v1/v2 content is preserved.

This branch is a full re-architecture of the docs:

  • Config migrated from mint.jsondocs.json (Mintlify's newer format) with three versions: v3, v2, v1.
  • v1/v2 content moved into legacy/, integration providers into applications/providers/, v3 content into v3/.
  • v2 shares API reference, SDK, and changelog from the (newer) v3 sources.

Latest sync from main

main had advanced with content updates that were merged into this branch with a path-aware strategy (so nothing landed in dead directories):

  • v1/v2 (legacy/*): took main's content — Cobalt→Refold rebrand + updated API links.
  • v3 / shared areas: kept the newer v3 versions (already rebranded; changelog current to v3.5.36).
  • Added new v1/v2 pages (environment-variables, encrypted-output-fields, best-practices) and providers (databricks, freshservice), wired into nav.

Verification

  • docs.json valid JSON; all new nav pages + images resolve
  • ✅ Zero conflict markers; no parse/syntax errors (mintlify broken-links)
  • ✅ 0 net-new broken links vs the branch baseline (500 pre-existing legacy links)

⚠️ Note for reviewers

  • The diff shows ~27.8k files, but 26,471 are committed node_modules/ (not gitignored). Only ~1,345 are actual doc changes. Recommend gitignoring + removing node_modules/ before/with this launch to make the PR reviewable.
  • Pre-existing (unrelated): the v1 "Guides" tab nav points to legacy/guides/... while files are at legacy/guides-v1v2/... (10 broken nav links).

🤖 Generated with Claude Code

abhishekjd and others added 30 commits July 6, 2025 00:26
Changes to node documentation - 1 aug
…ps and pages to enhance organization and clarity.
 Updated v3 documentation for various nodes, enhancing clarity and structure
lokeshwar-t and others added 12 commits June 29, 2026 18:41
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
… end users

The MCP pages were written May 11 and ported to this branch June 24, before
the mid-June product changes landed, so several pages described a product that
no longer exists. This brings all 13 MCP pages in line with current UAT and
rewrites them for the external developer instead of the Refold internals.

Correctness:
- Drop the ?mode=agent / ?expose_skills / ?provider query params. Mode and
  skill exposure are server-config toggles, resolved server-side per request.
- Replace the retired SEARCH_INTEGRATION_GRAPH with GET_KNOWLEDGE_INDEX and
  document its behavior and the real discovery flow.
- Fix the pattern model: direct and agent are mutually exclusive modes, not
  three independent toggles; skills and workflows layer onto the active mode.
- Remove the non-existent AUTH tool; describe the real re-authorization flow.
- Stop claiming internal_error is exposed; drop chains/notebooks/evals refs.

End-user gaps:
- Document both connection URL forms (path token and Authorization: Bearer).
- Add the success/failure contract and status codes (401/403/404/503).
- State the one URL = one linked account = one tenant model.

Voice:
- De-internalize: drop internal field/service/datastore names; state guarantees
  rather than implementation.
- Remove all em dashes.

Also re-add the SAP S/4HANA skill example and point the security page to the
platform Security section for org-wide posture.

Follow-ups (not blocking): refresh 9 old-UI screenshots; confirm the Auth Tool
surface and Server-URL token TTL with engineering.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Ran an unbiased per-page adversarial re-verification of all 13 MCP pages
against the current UAT code and applied 20 fine-grained corrections:

- Drop the unverified workflow "retries/rollback" guarantee; the workflow
  authority page only promises error handling (choose-your-pattern, workflow-as-mcp).
- MCP Logs: there is no Session ID filter and stateless HTTP discards the
  session, so reframe "trace a full session" to filter by linked account.
- Error handling: the agent gets a clean user-facing message and the logs
  detail panel shows that same message; the full upstream error is not
  exposed. Align debugging.mdx and reference/tools.mdx with mcp-logs.mdx.
- Correct validation_error vs execution_error classification (debugging).
- Remove the invented skills_summary field from the LOAD_SKILL example.
- RESOLVE_ACTIONS ordering is instructed by tool descriptions, not enforced
  by a runtime guard (reference/tools).
- Fix the server-configuration link target (was pointing at architecture).
- Tenant terminology made consistent on the security page.
- Retention stated as plan-based rather than a hardcoded 90 days (unverified).
- MCP Inspector attributed to the MCP project, not Anthropic.
- Agent mode reaches actions and workflows; "per-action tools" not "raw
  tools"; en-dash to hyphen in a copyable template; soften "Most" to "Many".

Mermaid: fix dark-mode contrast on all four diagrams. Mintlify forces the
mermaid text color per site theme, so a static fill failed in one mode.
Use transparent node fills so the text sits on the page background and
adapts to light and dark. Verified in both modes.

The "Auth Tool" toggle row is kept pending confirmation: it is a real
setup-UI toggle, but its exact surface should be confirmed with engineering.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…balt to Refold

- Updated links and references in connection-status.mdx, data-ref-node.mdx, wait-for-webhook.mdx, api-trigger.mdx, and events.mdx to use app.refold.ai instead of gocobalt.io.
- Removed outdated client-side JavaScript and React SDK documentation files.
- Deleted overview and server-side Node.js SDK documentation files as they are no longer relevant.
… setup guides

Rebrand app.gocobalt.io to app.refold.ai in application docs
Removed all API reference for docs.gocobalt.io, api.gocobalt.io, etc.
--All dead links, unreferenced files, placeholders removed
--API references to api.gocobalt.io --> app.refold.ai
--Page redirects -- docs.gocobalt.io -->docs.refold.ai
--Applications URL changes --> app.gocobalt.io --> app.refold.ai/tables...
Duplicated API References for v2,
v2 independent of v3 pages
Aadi7029 and others added 2 commits June 30, 2026 18:51
…ee-also to integration-logs

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
docs: Audit page, Rerun Execution API, and Agent node field cleanup
Tanmayy-B and others added 4 commits June 30, 2026 14:38
Sync the MCP docs PR with the latest abhishek branch for review and merge.

Conflicts were limited to four MCP pages where abhishek repointed the
connector-setup link after removing the old developer-docs path. Resolved by
keeping the corrected MCP content from this branch and adopting abhishek's new
link target (/v3/platform/concepts/connector/supported-apps-actions) in
server-configuration, authentication, architecture, and getting-started.

Also: abhishek's cleanup removed the v3/platform/security/* stub pages, so the
"Platform security and compliance" pointer added earlier on
operate/security-compliance.mdx now had no target. Removed that section; the
page still fully documents the MCP-specific security model.

Verified on the merged tree: 0 broken links in the MCP pages, 0 em dashes,
no conflict markers, all four mermaid diagrams intact.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ogy)

A 19-agent public-readiness audit (competitor benchmark vs modelcontextprotocol.io
/ Anthropic / Cloudflare / Stripe / Vercel, per-page review, and terminology /
first-user / framing / completeness critics) found the set already at the public
bar (0 critical, all pages minor-polish). This applies the safe polish it surfaced.

Framing:
- Lead interior pages with the content or guarantee instead of a "This page
  documents/covers..." opener (security-compliance, authentication, architecture,
  choose-your-pattern).
- Add a "two roles" model to the landing page (the platform team configures a
  server and issues each end user a URL; the end user's agent consumes it) so a
  public reader can place themselves, and make the without-Refold vs with-Refold
  value explicit.

Terminology (one concept, one word):
- The individual person a token/URL maps to is "end user", not "customer".
- The reusable integration package is a "connector", not app/application/integration.

Clarity and hygiene:
- Explain the <domain>/<token>/<server_id> placeholders once (the dashboard hands
  a fully-populated Server URL); standardize placeholder names.
- Gloss GET_KNOWLEDGE_INDEX and LOAD_SKILL to the "skills" concept without renaming.
- Fix an iframe close tag and two JSON code fences; assorted grammar/scannability.

Guardrails held: no change to any URL/path (/mcp/v1 is confirmed correct), tool
name, mode, or technical claim; zero em dashes; zero broken links.

Deferred to tickets (need engineering facts): error reference, a consolidated
limits page (rate limits / 429), programmatic provisioning, a client/OAuth
compatibility matrix, EXECUTE_ACTION idempotency, deeper security page, and the
GET_KNOWLEDGE_INDEX -> LIST_SKILLS rename (a product/code change).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
docs(mcp): correct the MCP section to current product and rewrite for end users
lokeshwar-t and others added 3 commits July 1, 2026 14:22
Bring in latest from abhishek (MCP public-readiness polish, Audit page,
Backup & restore updates, Rerun Execution endpoint, air-gapped removal).

Conflict resolutions:
- Control Plane: keep our dashboard-guide rewrite (abhishek did not edit it).
- refold-cp -> refold-managed: keep our rename; apply abhishek's edits to the
  renamed file.
- Air-gapped: accept abhishek's full removal (file, nav entry, and remaining
  links in overview and helm).
- Go-live checklist: keep removed (honor our deletion); drop the dangling nav
  entry and the go-live cards in overview and backup-restore.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
feat: add "Download as Markdown" button and enhance copy functionality
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.

10 participants