@salesforce/b2c-tooling-sdk / docs / DocEntry
Interface: DocEntry
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:58
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; guide entries are indexed locally but their full content is fetched on demand from DocEntry.url.
Properties
category?
optionalcategory:DocCategory
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:68
The corpus/category this entry belongs to.
filePath?
optionalfilePath:string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:74
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).
headings?
optionalheadings:string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:91
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
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?
optionalkeywords:string[]
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:95
Search keywords/synonyms an agent or developer might use to find this doc.
preview?
optionalpreview:string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:97
Optional preview/excerpt from the document.
sourceUrl?
optionalsourceUrl:string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:89
The raw-markdown (.md) URL for the same document — the machine-readable source. For online-only entries (guides) this is what readEntryContent 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?
optionalsummary:string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:93
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
The title from the document's first heading (e.g., "Class ProductMgr").
url?
optionalurl:string
Defined in: packages/b2c-tooling-sdk/src/docs/types.ts:81
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).