Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 0 additions & 61 deletions COMPONENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Whether you’re using core components or experimenting with new ones, this guid
- [Using IntegrationsGrid](#using-integrationsgrid)
- [Using CaptionedImage](#using-captionedimage)
- [Using DocsTable](#using-docstable)
- [Using PhotoCarousel](#using-photocarousel)
- [Using RelatedRead](#using-relatedread)
- [Using ToolTipTerm](#using-tooltipterm)
- [Using SdkGuideLinks](#using-sdkguidelinks)
Expand Down Expand Up @@ -312,66 +311,6 @@ Archetypes:
- feature-guide
- feature-summary

## Using PhotoCarousel

Role: Provide annotated walk-through using an image carousel presentation with text.

How to import:

```
import { PhotoCarousel } from '@site/src/components';
```

or

```
import PhotoCarousel from "@site/src/components/elements/PhotoCarousel";
```

Usage:

```
<PhotoCarousel
images={[
"/link/to/image-1",
"/link/to/image-2",
...
]}
captions={[
"caption-1",
"caption-2",
...
]}
/>
```

- If links are stored on-site, place images in static in an appropriately themed folder.
- If links are stored off-site, use a fully specified URL
- Please ensure the caption count and order matches that of the images
- You may pass an optional `isDarkMode` Boolean prop

### Skipping captioning

To skip slide captioning, pass the string `"NA"` instead of a normal description.

```
<PhotoCarousel
images={[
"/link/to/image-1",
"/link/to/image-2",
...
]}
captions={[
"NA",
"caption-2",
...
]}
/>
```

Photo 1 will not have a caption but photo 2 will have a caption.
This ensures photo 2 won't be matched with caption 1.

## Using ToolTipTerm

Role: Provide definitions or background information at the point of use.
Expand Down
10 changes: 7 additions & 3 deletions COMPONENT_REGISTRY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

Generated by `scripts/audit-components.mjs`. Run to update.

**Coverage: 36/44 (82%)**
**Coverage: 40/48 (83%)**

| Component | File Count | Strategy | Covered |
|-----------|------------|----------|---------|
| `TabItem` | 82 | `tabitem` | ✅ |
| `Tabs` | 81 | `tabs` | ✅ |
| `ReleaseNoteHeader` | 72 | `release-note-header` | ✅ |
| `ReleaseNoteHeader` | 71 | `release-note-header` | ✅ |
| `NoZoom` | 60 | `UNKNOWN` | ❌ |
| `RelatedReadContainer` | 23 | `related-read-container` | ✅ |
| `ViewSourceCodeNotice` | 23 | `view-source-code-notice` | ✅ |
| `RelatedReadItem` | 20 | `related-read-item` | ✅ |
| `SetupSteps` | 14 | `setup-steps` | ✅ |
| `SetupStep` | 14 | `setup-step` | ✅ |
Expand All @@ -20,7 +19,12 @@ Generated by `scripts/audit-components.mjs`. Run to update.
| `SdkTabs` | 9 | `sdk-tabs` | ✅ |
| `CallToAction` | 8 | `call-to-action` | ✅ |
| `CaptionedImage` | 7 | `captioned-image` | ✅ |
| `ViewSourceCodeNotice` | 6 | `view-source-code-notice` | ✅ |
| `IntegrationsGrid` | 6 | `integrations-grid` | ✅ |
| `CodeToCommandsDemo` | 5 | `strip-block` | ✅ |
| `CommandsToEventsDemo` | 5 | `strip-block` | ✅ |
| `HistoryReplayDemo` | 5 | `strip-block` | ✅ |
| `NonDeterminismDemo` | 5 | `strip-block` | ✅ |
| `ToolTipTerm` | 4 | `tooltip-term` | ✅ |
| `JsonTable` | 3 | `json-table` | ✅ |
| `AWSRegions` | 2 | `transclude` | ✅ |
Expand Down
1 change: 0 additions & 1 deletion MARKDOWN_PIPELINE.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,6 @@ Each component maps to a strategy in `COMPONENT_REGISTRY` (in `scripts/mdx-to-md
| `CodeSnippet` | `code-snippet` | Fenced code block using the `language` prop |
| `CaptionedImage`, `EnlargeImage`, `Components.CaptionedImage` | `captioned-image` | `![alt or caption or title](src)` |
| YouTube/`<iframe>` embeds (often in a styled `<div>`) | strip | Removed; keep a markdown Watch link in surrounding tip/prose for LLMs |
| `PhotoCarousel` | `photo-carousel` | One `![caption](url)` per entry in the `images`/`captions` arrays |
| `CallToAction` | `call-to-action` | `- [h3 title](href): p description` |
| `ReleaseNoteHeader` | `release-note-header` | `> **Public Preview** — Go, Java…` availability note + body blockquote. The self-closing form (`<ReleaseNoteHeader … />`) emits just the note and leaves the page body intact. |
| `RelatedReadContainer` / `RelatedReadItem` | `related-read-container` / `related-read-item` | `**Related:**` Markdown link list |
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/go/workflows/basics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ tags:
- Temporal SDKs
---

import { ViewSourceCodeNotice } from '@site/src/components';

## How to develop a basic Workflow {/* #develop-workflows */}

Workflows are the fundamental unit of a Temporal Application, and it all starts with the development of a [Workflow Definition](/workflow-definition).
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/go/workflows/cancellation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ tags:
- Temporal SDKs
---

import { ViewSourceCodeNotice } from '@site/src/components';

This page shows the following:

- How to handle a Cancellation request within a Workflow.
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/go/workflows/schedules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ tags:
description: Schedule Workflows, start them with delays or as Temporal Cron Jobs using the Go SDK. Master scheduling, backfilling, pausing, deleting, and updating Workflows.
---

import { ViewSourceCodeNotice } from '@site/src/components';

This page shows how to do the following:

- [Scheduled Workflows](#schedule-a-workflow)
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/python/activities/execution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ tags:
- Activity
---

import { ViewSourceCodeNotice } from '@site/src/components';

## Start an Activity Execution {/* #activity-execution */}

**How to start an Activity Execution using the Temporal Python SDK.**
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/python/activities/timeouts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ tags:
- Temporal SDKs
---

import { ViewSourceCodeNotice } from '@site/src/components';

## Set Activity timeouts {/* #activity-timeouts */}

Each Activity timeout controls the maximum duration of a different aspect of an Activity Execution.
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/python/workflows/basics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ tags:
- Temporal SDKs
---

import { ViewSourceCodeNotice } from '@site/src/components';

## Develop a basic Workflow {/* #develop-workflows */}

Workflows are the fundamental unit of a Temporal Application, and it all starts with the development of a
Expand Down
2 changes: 0 additions & 2 deletions docs/develop/python/workflows/timers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ tags:
- Temporal SDKs
---

import { ViewSourceCodeNotice } from '@site/src/components';

A Workflow can set a durable Timer for a fixed time period.
In some SDKs, the function is called `sleep()`, and in others, it's called `timer()`.

Expand Down
Loading