# All Docs Index Agents: start with [Workspace for Agents](https://workspace.socra.com/solutions/agents.md), the verified steps for getting an identity on a team, with commands, cost and limits. Socra: Fill the roles your team needs with proactive AI teammates, each with its own computer, identity and role. Canonical: https://socra.design/navigation/docs-index ## Governing rules [Building with Socra components](https://socra.design/agents.md) explains setup, consumption rules and verification. Semantic owner: Flash Module `workspace-reading-shell` in Socra Cortex when available. It supplies current intent and prerequisite rules; the public API below supplies exact code names and values. Use published property names, not inspector labels. Composition and preview settings are not component props. Public styling escape hatches do not permit product-local presentation overrides. The complete documentation home inside its shared reading shell. Use DocsIndexPage to show starting points, all documentation, and product destinations from the same catalog that supplies navigation. Status: partial. The specimen exercises the complete shared index and shell with fictional content. Host catalogs and service actions require consumer review. Library: @socra/web-docs ## Anatomy - Global property header and compact documentation header - Full-width documentation search - Get started entries with product marks - Every product and category expanded - Explore by product after a section divider - Persistent desktop sidebar and shared footer ## States - **Rest:** Every documentation section stays expanded without counts or disclosure controls. - **Hover:** Shared link treatments identify available destinations. - **Focus:** Keyboard users can open search and browse documentation destinations. - **Pressed:** Search opens the shared dialog; document links open their pages. - **Selected:** The index has no selected document; the article sidebar identifies the current page. - **Disabled:** Unavailable destinations do not appear as enabled controls. - **Loading:** The complete catalog is available from provider data without a second loading layout. - **Error:** Search preserves the entered query and identifies when no documents match. ## Motion The mobile global header hides down and returns up; the contextual header follows its visible edge. Desktop keeps one global header. Navigation overlays preserve reading position. ## Usage - Use the same provider data for the index and navigation. New documentation then appears in both places. - Let the reading shell own page spacing. Search, titles, and rows align without nested padding. ## Avoid - Keep index sections permanently expanded. Readers can scan all documents without extra actions. - Avoid a second index title or breadcrumb. The shell already identifies All Docs. ## Properties [Complete public API, including inherited properties and event signatures](https://socra.design/navigation/docs-index/api.md) ### Setup - Use the host-selected compatible Socra theme provider and published component styles. Keep one compatible provider instance across shared packages. - Import @socra/web-docs/styles.css and mount the required TanStack Router and DocsProvider configuration. The catalog memory router is a preview host; products supply their router. ### DocsIndexPage Import: `import { DocsIndexPage } from '@socra/web-docs';` | Property | Type or permitted values | Default / omission | Required | Meaning and behavior | Inspector | | --- | --- | --- | --- | --- | --- | | `markdown` | `string \| undefined` | Omitted; no declared default | no | | Direct API | | `markdownPath` | `string \| undefined` | Omitted; no declared default | no | | Direct API | | `marks` | `Readonly>` | Required input | yes | | Direct API | | `startingPoints` | `readonly DocsStartingPoint[]` | Required input | yes | | Direct API | ### DocsProvider Import: `import { DocsProvider } from '@socra/web-docs';` | Property | Type or permitted values | Default / omission | Required | Meaning and behavior | Inspector | | --- | --- | --- | --- | --- | --- | | `children` | `ReactNode` | Required input | yes | | Direct API | | `config` | `DocsConfig` | Required input | yes | | Direct API | ### DocsShell Import: `import { DocsShell } from '@socra/web-docs';` | Property | Type or permitted values | Default / omission | Required | Meaning and behavior | Inspector | | --- | --- | --- | --- | --- | --- | | `area` | `string \| undefined` | Omitted; no declared default | no | | Direct API | | `children` | `ReactNode` | Required input | yes | | Direct API | ### DocsArticle Import: `import { DocsArticle } from '@socra/web-docs';` | Property | Type or permitted values | Default / omission | Required | Meaning and behavior | Inspector | | --- | --- | --- | --- | --- | --- | | `onOptionChange` | `((group: string, value: string) => void) \| undefined` | Omitted; no declared default | no | | Direct API | | `page` | `DocPage` | Required input | yes | | Direct API | | `values` | `Record \| undefined` | Omitted; no declared default | no | | Direct API | ### SiteHeader Import: `import { SiteHeader } from '@socra/ui-web-landing';` | Property | Type or permitted values | Default / omission | Required | Meaning and behavior | Inspector | | --- | --- | --- | --- | --- | --- | | `appearance` | `"company"`, `"product"` | Omitted; no declared default | no | Preserves the company glass or product service-catalog presentation. | Direct API | | `brand` | `ReactNode` | Omitted; no declared default | no | A property-owned wordmark node rendered beside the Socra mark. | Direct API | | `brandHref` | `string \| undefined` | `'/'` | no | Where the property wordmark links. | Direct API | | `brandLabel` | `ReactNode` | Omitted; no declared default | no | A property-owned label rendered in the canonical Socra lockup. | Direct API | | `brandMark` | `ReactNode` | Omitted; no declared default | no | Product-owned identity artwork. | Direct API | | `companyHref` | `string \| undefined` | `'https://socra.com'` | no | The company destination carried by the Socra mark. | Direct API | | `hideOnScroll` | `false`, `true`, `"mobile"` | Omitted; no declared default | no | Hide down and reveal up on all screens, compact screens only, or never. Defaults to true. | Direct API | | `items` | `readonly SiteHeaderItem[]` | Required input | yes | The top-level tabs, in order. | Direct API | | `linkComponent` | `ElementType \| undefined` | `"a"` | no | Anchor-compatible host router adapter. Defaults to a native anchor. | Direct API | | `primaryAction` | `SiteHeaderAction \| undefined` | Omitted; no declared default | no | The new-user action, rendered as the filled squircle. | Direct API | | `secondaryAction` | `SiteHeaderLoginAction \| undefined` | Omitted; no declared default | no | The canonical filled-secondary Log in action. | Direct API | | `skipToContent` | `false`, `true` | Omitted; no declared default | no | Disable when the containing page shell already owns its bypass link. | Direct API | ### MarketingFooter Import: `import { MarketingFooter } from '@socra/ui-web-landing';` | Property | Type or permitted values | Default / omission | Required | Meaning and behavior | Inspector | | --- | --- | --- | --- | --- | --- | | `brandHref` | `string \| undefined` | `"/"` | no | Destination of the footer brand lockup. | Direct API | | `brandLabel` | `ReactNode` | Omitted; no declared default | no | Property-owned label beside the shared Socra mark. | Direct API | | `brandMark` | `ReactNode` | Omitted; no declared default | no | Shared product identity artwork. | Direct API | | `copyright` | `ReactNode` | Omitted; no declared default | no | Copyright line. Defaults to the current year against the Socra name. | Direct API | | `groups` | `readonly MarketingFooterGroup[] \| undefined` | `[]` | no | The titled groups, in reading order. | Direct API | | `legal` | `readonly MarketingFooterLink[] \| undefined` | `[]` | no | The utility-row destinations rendered against the copyright. | Direct API | | `linkComponent` | `ElementType \| undefined` | `"a"` | no | Consumer router link element. | Direct API | | `locale` | `ReactNode` | Omitted; no declared default | no | Optional property-owned locale shown in the utility row. | Direct API | | `showTagline` | `false`, `true` | `true` | no | Show the canonical company signature. Omit it when the page needs only its identity. | Direct API | ### Behavior and constraints - DocsProvider config supplies pages, areas, groups, portable Markdown, host links and footer. Search and native destinations are real; the catalog supplies a memory router and fictional data. ### Inspector mappings | Setting | Initial preview value | Consumed code | | --- | --- | --- | | Viewport | `390` | preview: Set the embedded browser viewport width in CSS pixels; this is not a component width prop. | | Theme | `dark` | preview: Set the embedded document theme provider; does not change document content. | ## Example ```tsx import type { ComponentProps } from 'react'; import { DocsIndexPage, DocsProvider, DocsShell, type DocsConfig } from '@socra/web-docs'; import '@socra/web-docs/styles.css'; import { SiteHeader } from '@socra/ui-web-landing'; // Render inside the host router and compatible shared theme providers. // config supplies areas, pages, groups, and the host footer. export function DocumentationHome({ config, index }: { config: DocsConfig; index: ComponentProps; }) { return ( <> ); } ```