---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [docs](../index.md) / DocEntry

# Interface: DocEntry

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:58](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L58)

A documentation entry in the search index.

Entries span multiple corpora (Script API reference, job steps, Developer
Center guides, and this project's own docs). Reference entries are bundled
on disk and read via [DocEntry.filePath](#filepath); guide entries are indexed
locally but their full content is fetched on demand from [DocEntry.url](#url).

## Properties

### category?

> `optional` **category**: [`DocCategory`](../type-aliases/DocCategory.md)

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:68](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L68)

The corpus/category this entry belongs to.

***

### filePath?

> `optional` **filePath**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:74](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L74)

Path of the bundled markdown file relative to its corpus data directory.
Present for entries whose content ships in the package; absent for entries
whose content is fetched online (see [DocEntry.sourceUrl](#sourceurl)).

***

### headings?

> `optional` **headings**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:91](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L91)

Section headings joined into a single searchable string (indexed, not for display).

***

### id

> **id**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:64](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L64)

Unique identifier. For bundled reference this is the filename without its
extension (e.g., "dw.catalog.ProductMgr"); for guides it is namespaced by
category to avoid cross-corpus collisions (e.g., "sfnext/sfnext-get-started").

***

### keywords?

> `optional` **keywords**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:95](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L95)

Search keywords/synonyms an agent or developer might use to find this doc.

***

### preview?

> `optional` **preview**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:97](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L97)

Optional preview/excerpt from the document.

***

### sourceUrl?

> `optional` **sourceUrl**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:89](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L89)

The raw-markdown (`.md`) URL for the same document — the machine-readable
source. For online-only entries (guides) this is what [readEntryContent](../functions/readEntryContent.md)
fetches at read time. Bundled corpora (Script API, tooling) also carry it so
callers can retrieve the raw source on request even though content ships in
the package. Absent for corpora with no public page (job steps).

***

### summary?

> `optional` **summary**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:93](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L93)

One-line summary describing what task/topic the doc helps with (agent triage).

***

### title

> **title**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:66](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L66)

The title from the document's first heading (e.g., "Class ProductMgr").

***

### url?

> `optional` **url**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:81](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/docs/types.ts#L81)

Canonical human-facing published URL (the rendered `.html` page, e.g. on
developer.salesforce.com). This is the durable link to cite/open in a
browser. Present for every corpus that has a public page (guides, Script
API reference, tooling); absent for corpora with no public page (job steps).