Skip to main content

Getting started

Orientation for new readers of the Walnut KB.

Getting started

Welcome to the Walnut Knowledge Base. This site is the single source of truth for everything Walnut: product docs, API reference, internal runbooks, and release notes.

  • Product tabs at the top split content by product area: Demos, Playlists, Deal rooms, Content hubs, Integrations, API & webhooks, Account & admin.
  • Sidebar on the left scopes to the active product. It stays pinned as you scroll.
  • ⌘K opens the search modal from anywhere. Type to filter.
  • Ask AI in the navbar pops a chat assistant trained on these docs (lands with WOS-162).

Where things live​

The repo at teamwalnut/kb is structured as:

  • docs/ — public help center content. Markdown / MDX.
  • blog/ — release notes and announcements.
  • src/components/ — custom React components used in docs (e.g. <WalnutDemo />).
  • static/ — images, fonts, and other assets.

See CONTRIBUTING.md for the frontmatter schema, including how to add an FAQ block like the one at the bottom of this page.

Code block example​

terminal
# Run the dev server
pnpm install
pnpm start
src/data/products.ts
export const PRODUCTS = [
  {id: 'demos', label: 'Demos', path: '/help/demos'},
  {id: 'playlists', label: 'Playlists', path: '/help/playlists'},
];

Callout examples​

Authors can use either the MDX :::kind syntax or the <Callout> JSX element.

The Callout component supports **markdown** in the body — including [links](/), `inline code`, and lists. Use the JSX form when you need to pass a custom `title` or compose with other React.

Table example​

ComponentStatusLinear
<Callout>ShippedWOS-199
Code block chromeShippedWOS-200
<NextSteps> + tables + imagesShippedWOS-201

Image example​

Walnut logo
Walnut logo, rendered inside a figure element with a caption.

<NextSteps items={[ {to: '/docs/help/demos', label: 'Explore Demos', blurb: 'Build, edit, and share interactive demos.', icon: 'play'}, {to: '/docs/help/integrations', label: 'Connect Salesforce', blurb: 'Sync demo activity into your CRM.', icon: 'plug'}, {to: '/docs/help/api-webhooks', label: 'API & webhooks', blurb: 'Programmatic access to demos and events.', icon: 'code'}, {to: '/docs/help/account-admin', label: 'Workspace settings', blurb: 'Manage SSO, members, and billing.', icon: 'settings'}, ]} />

Frequently asked questions

What kinds of articles will live in this knowledge base?

Three buckets, all in the same Git repo: product how-tos (migrated from Zendesk and added to as the product evolves), API/SDK reference (auto-updated from production on merge), and internal-only docs for the Walnut team. All three are searchable through the same ⌘K modal.

Can I read articles as Markdown?

Yes — every article is also served as raw Markdown at /articles/{slug}.md. The site also publishes /llms.txt and a structured sitemap, so AI agents can ingest the KB cleanly. See the "For LLMs & agents" block on the home page.

How do I contribute a fix or a new article?

Edit any page directly on GitHub — every article has an "Edit this page" link. Walnut CX editors can also use the in-house admin at /admin to edit articles in a side-by-side preview view; saves commit through the same Git workflow.

Does the FAQ block show up in Google?

Yes — this section emits a <script type="application/ld+json"> block with FAQPage schema so search engines can render Q&A pairs as Rich Results. See CONTRIBUTING.md for the frontmatter schema.

Was this helpful?