diff --git a/Docs/PowerForge.Web.ApiDocs.md b/Docs/PowerForge.Web.ApiDocs.md index 2a3b59e6..1581f347 100644 --- a/Docs/PowerForge.Web.ApiDocs.md +++ b/Docs/PowerForge.Web.ApiDocs.md @@ -43,6 +43,11 @@ Overview identity and quick start: - `short` keeps short names only - `namespace-suffix` (default) disambiguates duplicates as `Type (Namespace.Part)` - `full` uses full type names +- `generateGitFreshness` (pipeline) / `--git-freshness` (CLI) enables opt-in git freshness metadata: + - `gitFreshnessNewDays` / `--git-freshness-new-days` controls the `new` window (default `14`) + - `gitFreshnessUpdatedDays` / `--git-freshness-updated-days` controls the `updated` window (default `90`) + - emitted JSON adds `freshness.status`, `freshness.lastModifiedUtc`, `freshness.commitSha`, `freshness.ageDays`, and a normalized `freshness.sourcePath` (relative when possible; file-name fallback otherwise) + - HTML badges render only for `new` / `updated`; `stable` remains unbadged to avoid visual noise If your site uses `Navigation.Profiles` (route/layout specific menus), set: - `navContextPath` (defaults to `/`) @@ -150,6 +155,13 @@ Overview chips: - `.type-chip` – type chip link - `.type-chip.` – kind class (`class`, `struct`, `enum`, `interface`, `delegate`) - `.type-chip` includes `data-kind` and `data-namespace` for filtering +- `.freshness-badge` – freshness badge shell +- `.freshness-badge.new` – recent/new state +- `.freshness-badge.updated` – recently updated state +- `.type-freshness-badge` – type detail header placement +- `.type-list-freshness` – sidebar row placement +- `.quick-card-freshness` – quick-start card placement +- `.type-chip-freshness` – namespace chip placement Member layout: - `.member-toolbar` – member filter toolbar @@ -203,6 +215,11 @@ Member layout: - `.derived-list` – derived types list - `.type-parameters` – type parameter section - `.type-examples` – example section +- `.example-media` – example media figure wrapper +- `.example-media-frame` – media surface (image/video/link frame) +- `.example-media-link` – terminal/download link for non-inline example media +- `.example-media-caption` – media caption +- `.example-media-meta` – capture recency / freshness metadata line - `.type-see-also` – see also section ## JavaScript expectations @@ -261,6 +278,24 @@ in the pipeline or pass `--documented-only` to the CLI. `` and `` tags are converted into links when the referenced type exists in the generated API docs. +XML-doc `` blocks can also include optional media nodes for richer API examples: + +```xml + + Sample.Run(); + Rendered output + + +``` + +Supported media nodes: +- `` / `` / `` +- `