Skip to content

Knowledge base#99

Merged
duharry0915 merged 6 commits intomainfrom
knowledgeBase
Mar 9, 2026
Merged

Knowledge base#99
duharry0915 merged 6 commits intomainfrom
knowledgeBase

Conversation

@duharry0915
Copy link
Collaborator

@duharry0915 duharry0915 commented Mar 9, 2026

Summary by cubic

Launches a new Knowledge Base with 24 developer-focused articles and a dedicated “KB” docs tab to improve setup, deliverability, and troubleshooting. Also renames the Agent onboarding page, adds redirects, and documents KB writing guidelines.

  • New Features

    • Added “Knowledge Base” tab and navigation in fern/docs.yml, including an introduction page with Cards.
    • Published 24 articles across Getting Started, Agent Patterns, Domains & Deliverability, Troubleshooting, and DNS Guides (Cloudflare, GoDaddy, Route 53, Namecheap).
    • Covered core topics: inbox creation, inbound via webhooks/WebSockets, threaded replies, labels, allow/block lists, pods, API keys, custom domains, SPF/DKIM/DMARC, warming, spam/bounce troubleshooting, rate limits, duplicate-send prevention, and MX record conflicts.
    • Added KB authoring guidelines in AGENTS.md (structure, SDK accuracy, linking, and categories).
    • Addresses the article set outlined in Linear ENG-323.
  • Refactors

    • Renamed “AI Onboarding” to “Agent Onboarding” and added a redirect (/integrations/ai-onboarding/integrations/agent-onboarding).
    • Minor nav/redirect cleanup in fern/docs.yml and final copy/grammar fixes across KB pages.

Written for commit 44d2231. Summary will update on new commits.

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

8 issues found across 27 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="fern/pages/knowledge-base/threaded-conversations.mdx">

<violation number="1" location="fern/pages/knowledge-base/threaded-conversations.mdx:109">
P3: This reply example omits `html`, which contradicts the earlier guidance to always send both `text` and `html`. Add the HTML payload so the example matches the documented requirement.</violation>
</file>

<file name="fern/pages/knowledge-base/domain-warming.mdx">

<violation number="1" location="fern/pages/knowledge-base/domain-warming.mdx:8">
P3: The SMTP credentials link is malformed (`/https://...`), which will render as a broken relative link. Use the absolute URL without the leading `/`.</violation>
</file>

<file name="fern/pages/knowledge-base/dns-route53.mdx">

<violation number="1" location="fern/pages/knowledge-base/dns-route53.mdx:59">
P2: This timing claim is misleading. Route 53 updates reach Route 53 name servers within ~60 seconds, but end‑user propagation can be longer due to DNS resolver caching. Rephrase to avoid implying a 1–5 minute end‑to‑end guarantee.</violation>
</file>

<file name="fern/pages/knowledge-base/emails-going-to-spam.mdx">

<violation number="1" location="fern/pages/knowledge-base/emails-going-to-spam.mdx:66">
P2: Remove the leading slash so the Discord invite resolves as an external link.</violation>

<violation number="2" location="fern/pages/knowledge-base/emails-going-to-spam.mdx:68">
P3: Add spacing (or split into two sentences) so the final line reads correctly.</violation>
</file>

<file name="fern/pages/knowledge-base/what-is-agentmail.mdx">

<violation number="1" location="fern/pages/knowledge-base/what-is-agentmail.mdx:7">
P3: The intro paragraph has multiple spelling/grammar errors that make the explanation hard to read; rewrite this line with correct wording.</violation>

<violation number="2" location="fern/pages/knowledge-base/what-is-agentmail.mdx:28">
P3: This bullet has grammar agreement errors (`first class user`, `They needs`), which weakens readability.</violation>

<violation number="3" location="fern/pages/knowledge-base/what-is-agentmail.mdx:34">
P3: Fix the typo in this heading (`platfroms` → `platforms`).</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@duharry0915
Copy link
Collaborator Author

@cubic

@cubic-dev-ai
Copy link

cubic-dev-ai bot commented Mar 9, 2026

@cubic

@duharry0915 I have started the AI code review. It will take a few minutes to complete.

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

5 issues found across 27 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="fern/pages/knowledge-base/inbox-capabilities.mdx">

<violation number="1" location="fern/pages/knowledge-base/inbox-capabilities.mdx:85">
P2: Guard against an empty thread list before indexing `threads.threads[0]` in the example.</violation>
</file>

<file name="fern/pages/knowledge-base/spf-dkim-dmarc.mdx">

<violation number="1" location="fern/pages/knowledge-base/spf-dkim-dmarc.mdx:63">
P2: The DMARC `p=reject` explanation is incorrect: rejection is based on DMARC failure (typically when both SPF and DKIM fail alignment), not simply SPF or DKIM failing individually.</violation>
</file>

<file name="fern/pages/knowledge-base/allowlists-blocklists.mdx">

<violation number="1" location="fern/pages/knowledge-base/allowlists-blocklists.mdx:67">
P3: The Personal Agent description conflicts with the example below it ("from you" vs customer domains). Align the sentence with the shown example to avoid confusing setup guidance.</violation>
</file>

<file name="fern/pages/knowledge-base/rate-limits.mdx">

<violation number="1" location="fern/pages/knowledge-base/rate-limits.mdx:49">
P2: This guidance is misleading: `clientId` on inbox creation does not prevent duplicate `messages.send` retries. Clarify that send deduplication must be handled in app logic (or by draft workflow), while `clientId` only applies to create operations.</violation>
</file>

<file name="fern/docs.yml">

<violation number="1" location="fern/docs.yml:415">
P2: These API layout entries are duplicated. Keeping them twice will repeat the same sections in the API reference navigation. Remove the second set of `api-keys`, `pods`, and `organizations`.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

- websockets
- lists
- metrics
- api-keys
Copy link

@cubic-dev-ai cubic-dev-ai bot Mar 9, 2026

Choose a reason for hiding this comment

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

P2: These API layout entries are duplicated. Keeping them twice will repeat the same sections in the API reference navigation. Remove the second set of api-keys, pods, and organizations.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At fern/docs.yml, line 415:

<comment>These API layout entries are duplicated. Keeping them twice will repeat the same sections in the API reference navigation. Remove the second set of `api-keys`, `pods`, and `organizations`.</comment>

<file context>
@@ -406,4 +412,91 @@ navigation:
           - websockets
           - lists
           - metrics
+          - api-keys
+          - pods
+          - organizations
</file context>
Fix with Cubic

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No it is correct. we want to put it there.

Copy link

Choose a reason for hiding this comment

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

Got it—leaving those entries as-is.

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

@duharry0915 duharry0915 merged commit c22d1bd into main Mar 9, 2026
4 checks passed
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.

1 participant