document-lakebase-example

Add a Lakebase Cookbook example's documentation page to the Astro site and wire it into the sidebar, docs index, and landing-page data. Use after an example folder exists and needs to appear on lakebase-cookbook.com. Implements CONTRIBUTING.md section 4. Triggers on "document my example", "add my example to the site", "create the doc page", "add it to the cookbook site".

跳到安装

仓库: databricks-solutions/lakebase-cookbook
最近来源活动: 2026年8月3日 19:10
检测到的 SKILL.md 语言: 英语
星标: 0
分支: 9

安装方式

默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

直接命令不会经过审查 Prompt；运行前请先检查来源。

npx skills add https://github.com/databricks-solutions/lakebase-cookbook --skill document-lakebase-example

命令会保持在同一行。复制前请横向滚动并检查完整内容。

想先保存到本地？可下载 SkillsMP 当前能够提供的文件。

检查来源文件

决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。

文件资源管理器

2 个文件

SKILL.md

来源说明 · 只读预览

name	document-lakebase-example
description	Add a Lakebase Cookbook example's documentation page to the Astro site and wire it into the sidebar, docs index, and landing-page data. Use after an example folder exists and needs to appear on lakebase-cookbook.com. Implements CONTRIBUTING.md section 4. Triggers on "document my example", "add my example to the site", "create the doc page", "add it to the cookbook site".

Document a Lakebase Cookbook example on the site

Add the site doc page for an existing example and wire it into the navigation, per CONTRIBUTING.md §4. The site is an Astro project in site/ — see site/README.md.

Inputs

<name> — the example folder name (snake_case).
<slug> — the doc page slug (kebab-case, usually the folder name with underscores → hyphens, e.g. feature_store → feature-store).
<title>, <sidebar_label>, <description>.
A short list of the key points to surface (architecture, deploy, config).

Steps

1. Create the doc page

Create site/src/content/docs/examples/<slug>.mdx from this skill's templates/example.mdx.tmpl. Substitute __TITLE__, __SIDEBAR_LABEL__, __CATEGORY__, __DESCRIPTION__, __NAME__, __SLUG__, and __SIDEBAR_POSITION__.

category groups the example in the sidebar and on the landing page. Use the same category as the example's folder — current categories are Agents, Developer Experience, Apps, Data (order lives in site/src/lib/docs.ts).
sidebar_position orders within the category; use the category's number band (Agents 10s, Developer Experience 20s, Apps 30s, Data 40s). Read the other files in site/src/content/docs/examples/ and pick a value that fits.
Use .mdx (not .md) if you use the <Callout> component. Import it from ../../../components/Callout.astro.
Convert any Docusaurus-style :::note … ::: admonitions to <Callout type="info|note|tip|warning" title="…">…</Callout>.
No emojis.
The page is a shorter, styled mirror of the example's own README.md — do not duplicate the whole README; summarize and link to the source.
End with a Source callout linking to the example folder on GitHub.

The sidebar picks up the new file automatically (folder = group, sidebar_position = order — see site/src/lib/docs.ts). No sidebar config edit needed.

2. Feature it in the landing + docs index data

site/src/data/examples.ts — append an ExampleCard entry: { category, tag, title, bracket, description, href: '/docs/examples/<slug>/', status }. Use the same category as the doc-page frontmatter. Use status: 'ready' for a fully worked example, 'soon' for a stub. Match the tone of the existing entries (the bracket field is the short mono [like this] phrase).
site/src/content/docs/intro.md — add a row to the examples table pointing at /docs/examples/<slug>/.
Optionally add a card to site/src/data/resources.ts if it warrants a resource link.

3. Preview

From the repo root:

make dev     # http://localhost:3000 — check the page renders and the sidebar shows it
make build   # MUST succeed with no errors before the PR

If a visual check matters, follow the CLAUDE.md workflow (build, load with the chrome-devtools MCP, screenshot).

After documenting

Move on to verify-lakebase-example to lint, confirm the build, validate the bundle, and assemble the PR checklist.

返回搜索返回安装

contribute-lakebase-example

End-to-end guide for contributing a new example to the Lakebase Cookbook repository. Use when a contributor wants to add, build, document, or submit a Lakebase example (a new example folder under a category dir + its cookbook site doc page). Orchestrates scaffolding, documentation, and verification, following CONTRIBUTING.md. Triggers on "add an example", "contribute to the cookbook", "new Lakebase example", "document my example", or pointing an agent at CONTRIBUTING.md.

2026-08-03

scaffold-lakebase-example

Scaffold a new Lakebase Cookbook example folder — a snake_case directory under a category folder (agents/, apps/, developer_experience/, data/) with a Databricks Asset Bundle (databricks.yml + resources/), pyproject.toml (uv), README.md, .env.example, and .gitignore. Use when a contributor is starting a new example and needs the standard file layout and DAB templates. Implements CONTRIBUTING.md sections 1–3. Triggers on "scaffold an example", "start a new Lakebase example", "set up the example folder".

2026-08-03

verify-lakebase-example

Verify a Lakebase Cookbook contribution before opening a PR — lint with ruff, validate the Databricks Asset Bundle, build the Astro site, check for committed secrets, and produce the CONTRIBUTING.md PR checklist. Use when a contributor is ready to submit or wants to check their example is complete. Implements CONTRIBUTING.md sections 3, 5, and 6. Triggers on "verify my example", "check before I PR", "is my example ready", "run the checklist".

2026-08-03

查看这个仓库的全部 Skills

name	document-lakebase-example
description	Add a Lakebase Cookbook example's documentation page to the Astro site and wire it into the sidebar, docs index, and landing-page data. Use after an example folder exists and needs to appear on lakebase-cookbook.com. Implements CONTRIBUTING.md section 4. Triggers on "document my example", "add my example to the site", "create the doc page", "add it to the cookbook site".

Document a Lakebase Cookbook example on the site

Add the site doc page for an existing example and wire it into the navigation, per CONTRIBUTING.md §4. The site is an Astro project in site/ — see site/README.md.

Inputs

<name> — the example folder name (snake_case).
<slug> — the doc page slug (kebab-case, usually the folder name with underscores → hyphens, e.g. feature_store → feature-store).
<title>, <sidebar_label>, <description>.
A short list of the key points to surface (architecture, deploy, config).

Steps

1. Create the doc page

category groups the example in the sidebar and on the landing page. Use the same category as the example's folder — current categories are Agents, Developer Experience, Apps, Data (order lives in site/src/lib/docs.ts).
sidebar_position orders within the category; use the category's number band (Agents 10s, Developer Experience 20s, Apps 30s, Data 40s). Read the other files in site/src/content/docs/examples/ and pick a value that fits.
Use .mdx (not .md) if you use the <Callout> component. Import it from ../../../components/Callout.astro.
Convert any Docusaurus-style :::note … ::: admonitions to <Callout type="info|note|tip|warning" title="…">…</Callout>.
No emojis.
The page is a shorter, styled mirror of the example's own README.md — do not duplicate the whole README; summarize and link to the source.
End with a Source callout linking to the example folder on GitHub.

The sidebar picks up the new file automatically (folder = group, sidebar_position = order — see site/src/lib/docs.ts). No sidebar config edit needed.

2. Feature it in the landing + docs index data

site/src/data/examples.ts — append an ExampleCard entry: { category, tag, title, bracket, description, href: '/docs/examples/<slug>/', status }. Use the same category as the doc-page frontmatter. Use status: 'ready' for a fully worked example, 'soon' for a stub. Match the tone of the existing entries (the bracket field is the short mono [like this] phrase).
site/src/content/docs/intro.md — add a row to the examples table pointing at /docs/examples/<slug>/.
Optionally add a card to site/src/data/resources.ts if it warrants a resource link.

3. Preview

From the repo root:

make dev     # http://localhost:3000 — check the page renders and the sidebar shows it
make build   # MUST succeed with no errors before the PR

If a visual check matters, follow the CLAUDE.md workflow (build, load with the chrome-devtools MCP, screenshot).

After documenting

Move on to verify-lakebase-example to lint, confirm the build, validate the bundle, and assemble the PR checklist.

document-lakebase-example

来源信息

安装方式

检查来源文件

Document a Lakebase Cookbook example on the site

Inputs

Steps

1. Create the doc page

2. Feature it in the landing + docs index data

3. Preview

After documenting

同仓库更多 Skills

Document a Lakebase Cookbook example on the site

Inputs

Steps

1. Create the doc page

2. Feature it in the landing + docs index data

3. Preview

After documenting

同仓库更多 Skills