feat(app): redesign the docs and playground on one shared shell

.changeset/docs-part-jsdoc.md

@@ -0,0 +1,5 @@
+---
+"@intentface/chat": patch
+---
+
+Documentation only, no runtime change. Every part of `Attachments`, `Chip`, `Message`, `Reasoning` and `Steps` now carries JSDoc saying what it is for and which element it renders, so editors show the same reference as the docs site. The package README is refreshed to match the rewritten docs.

README.md

@@ -6,7 +6,8 @@ primitives for React — and the documentation site and playground at
 
 The package ships behavior, state, and wire formats with no styling of its own: a contenteditable
 composer with commands and chips, a thread with scroll auto-follow, message part segmentation, tool-call
-timelines. This is the Base UI model applied to chat — the package owns behavior, you own every class.
+timelines, and the app-shell parts around them — a collapsible sidebar, a nav tree, a closable tab
+collection. This is the Base UI model applied to chat — the package owns behavior, you own every class.
 
 ## Layout
 

app/(docs)/[[...slug]]/page.tsx

@@ -1,7 +1,10 @@
+import { ChevronRight } from "@keyline-icons/react";
 import { notFound } from "next/navigation";
 import { DocsTOC } from "@/components/docs/docs-toc";
+import { DocsTopBarTrigger } from "@/components/docs/docs-top-bar-trigger";
 import { PageActions } from "@/components/docs/page-actions";
-import { getPage, source } from "@/lib/docs/source";
+import { ProgressiveBlur } from "@/components/ui/progressive-blur";
+import { getPage, getSectionLabel, source } from "@/lib/docs/source";
 import { getMDXComponents } from "@/mdx-components";
 
 type PageProps = {
@@ -17,24 +20,60 @@ export default async function DocsPage(props: PageProps) {
   // fumadocs uses an empty slug for the docs index; the raw-markdown route keys
   // off the on-disk filename.
   const markdownSlug = slug?.length ? slug : ["index"];
+  const section = getSectionLabel(page.url);
 
   return (
-    <div className="mx-auto flex w-fit max-w-full gap-10">
-      <article className="w-full max-w-3xl shrink-0 pb-16">
-        <header id="overview" className="mb-4 flex flex-col gap-3">
-          <h1 className="font-semibold text-2xl text-ink-primary tracking-tight">
-            {page.data.title}
-          </h1>
-          {page.data.description && (
-            <p className="text-lg text-ink-secondary leading-7">{page.data.description}</p>
-          )}
-          <PageActions slug={markdownSlug} source={page.data.source} />
-        </header>
-        <div className="[&>*:first-child]:mt-0">
-          <MDXContent components={getMDXComponents()} />
+    <div className="flex min-h-full flex-col">
+      <header className="sticky top-0 z-10 isolate flex h-13 shrink-0 items-center justify-between gap-3 px-3">
+        {/* Content dissolves under the bar instead of cutting off: a progressive
+            blur plus a fade. */}
+        <ProgressiveBlur
+          direction="top"
+          blurIntensity={0.5}
+          className="pointer-events-none absolute inset-x-0 top-0 -z-10 h-14 bg-linear-to-b from-secondary-bg to-transparent"
+        />
+        <div className="flex min-w-0 items-center gap-2">
+          <DocsTopBarTrigger />
+          <nav aria-label="Breadcrumb" className="flex min-w-0 items-center gap-1.5 text-sm">
+            {section && (
+              <>
+                <span className="shrink-0 text-ink-secondary">{section}</span>
+                <ChevronRight className="size-3 shrink-0 text-ink-tertiary" aria-hidden />
+              </>
+            )}
+            <span className="truncate font-medium text-ink-primary">{page.data.title}</span>
+          </nav>
         </div>
-      </article>
-      <DocsTOC items={page.data.toc} />
+        <PageActions slug={markdownSlug} source={page.data.source} />
+      </header>
+      {/* isolate: demo z-indexes stay inside the page, below the sticky top bar. */}
+      <div className="isolate flex flex-1">
+        <div className="flex min-w-0 flex-1 justify-center px-5 pt-7 pb-24 md:px-12">
+          <article className="w-full min-w-0 max-w-[680px]">
+            <header id="overview" className="mb-7 flex scroll-mt-20 flex-col gap-2.5">
+              <h1 className="font-semibold text-[32px] text-ink-primary leading-[38px] tracking-[-0.02em]">
+                {page.data.title}
+              </h1>
+              {page.data.description && (
+                <p className="max-w-[600px] text-ink-body text-xl leading-[26px]">
+                  {page.data.description}
+                </p>
+              )}
+            </header>
+            <div className="[&>*:first-child]:mt-0 [&>h2:first-child]:border-0 [&>h2:first-child]:pt-0">
+              <MDXContent components={getMDXComponents()} />
+            </div>
+          </article>
+        </div>
+        {/* The changelog lists versions only, not each "Patch Changes" heading. */}
+        <DocsTOC
+          items={
+            page.url === "/changelog"
+              ? page.data.toc.filter((item) => item.depth === 2)
+              : page.data.toc
+          }
+        />
+      </div>
     </div>
   );
 }

app/(docs)/layout.tsx

@@ -1,14 +1,11 @@
 import type { ReactNode } from "react";
-import { DocsSidebar } from "@/components/docs/docs-sidebar";
-import { source } from "@/lib/docs/source";
 
+// The site shell lives in the root layout; the docs only add their own scroller.
+// The panel scrolls, not the window, so the frame stays put around it.
 export default function DocsLayout({ children }: { children: ReactNode }) {
   return (
-    <div className="flex min-h-screen bg-secondary-bg">
-      <DocsSidebar tree={source.pageTree} />
-      <div className="min-w-0 flex-1">
-        <main className="mx-auto w-full px-4 pt-10 md:px-6">{children}</main>
-      </div>
+    <div data-docs-scroll="" className="h-full w-full overflow-y-auto">
+      {children}
     </div>
   );
 }

app/fonts/IoskeleyMono-OFL.txt

@@ -0,0 +1,92 @@
+Copyright (c) 2025, Ahmed Hatem (https://github.com/ahatem)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+---
+
+## SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1. Neither the Font Software nor any of its individual components,
+   in Original or Modified Versions, may be sold by itself.
+
+1. Original or Modified Versions of the Font Software may be bundled,
+   redistributed and/or sold with any software, provided that each copy
+   contains the above copyright notice and this license. These can be
+   included either as stand-alone text files, human-readable headers or
+   in the appropriate machine-readable metadata fields within text or
+   binary files as long as those fields can be easily viewed by the user.
+
+1. No Modified Version of the Font Software may use the Reserved Font
+   Name(s) unless explicit written permission is granted by the corresponding
+   Copyright Holder. This restriction only applies to the primary font name as
+   presented to the users.
+
+1. The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+   Software shall not be used to promote, endorse or advertise any
+   Modified Version, except to acknowledge the contribution(s) of the
+   Copyright Holder(s) and the Author(s) or with their explicit written
+   permission.
+
+1. The Font Software, modified or unmodified, in part or in whole,
+   must be distributed entirely under this license, and must not be
+   distributed under any other license. The requirement for fonts to
+   remain under this license does not apply to any document created
+   using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.