Skip to content

Build topic documentation from pinned executable SDK examples - #55204

Draft
vgvoleg wants to merge 11 commits into
mainfrom
docs/topic-snippets
Draft

vgvoleg wants to merge 11 commits into
mainfrom
docs/topic-snippets

Conversation

@vgvoleg

@vgvoleg vgvoleg commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

Replace the copied topic SDK snippets in both documentation languages with regions from executable examples inside the SDK examples directories. Java sources live in ydb-java-examples.

Keep all 200 source blocks per language and their original scenarios. Separate alternatives execute independently; connection setup, fixture preparation, result checks and cleanup stay outside the published regions. Only current API and syntax corrections change the documentation content.

The manifest selects individual source files. The lock pins commits, Git blobs and SHA-256 digests. Preparation fetches those files before documentation and native builds, refreshing inputs when incremental graph comparison switches commits.

SDK Example PR Branch Commit
go ydb-platform/ydb-go-sdk#2333 docs/topic-snippets 8ad2661ef041
java ydb-platform/ydb-java-examples#68 docs/topic-snippets a220a4a6648b
python ydb-platform/ydb-python-sdk#915 docs/topic-snippets 0409ca98c5ee
dotnet ydb-platform/ydb-dotnet-sdk#723 docs/topic-snippets 783cfd6c1803
javascript ydb-platform/ydb-js-sdk#649 docs/topic-snippets e107f6825020
rust ydb-platform/ydb-rs-sdk#645 docs/topic-snippets 041636b79c6d
cpp ydb-platform/ydb-cpp-sdk#675 docs/topic-snippets 57e19f101afc

@ydbot

ydbot commented Oct 5, 2026

Copy link
Copy Markdown
Collaborator

Run Extra Tests

Run additional tests for this PR. You can customize:

  • Test Size: small, medium, large (default: small, medium)
  • Test Targets: any directory path (default: ydb/)
  • Sanitizers: ASAN, MSAN, TSAN
  • Coredumps: collected by default to a 100G /coredumps volume; can be disabled
  • Additional args: custom ya make arguments

▶  Run tests

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 5, 2026
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

❌ Documentation build

Revision build failed

Build logs

Errors (422)

❌ en/reference/ydb-sdk/topic.md: 1068: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1069: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1072: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1076: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1157: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1158: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1159: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1241: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1242: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1243: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1246: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1278: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1279: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1280: MD010 / no-hard-tabs Hard tabs [Column: 3]

❌ en/reference/ydb-sdk/topic.md: 1281: MD010 / no-hard-tabs Hard tabs [Column: 3]

Log was truncated. (407 records)

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-05 15:08:16 UTC Pre-commit check linux-x86_64-release-asan for febbc6b has started.
⚪ 2026-10-05 15:08:24 UTC Artifacts will be uploaded here
⚪ 2026-10-05 15:10:02 UTC ya make is running...
⚫ 2026-10-05 15:10:28 UTC Check cancelled

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-05 15:16:41 UTC Pre-commit check linux-x86_64-release-asan for f1bf034 has started.
⚪ 2026-10-05 15:16:51 UTC Artifacts will be uploaded here
⚪ 2026-10-05 15:18:32 UTC ya make is running...
🔴 2026-10-05 15:19:39 UTC Build failed, see the logs. Also see fail summary

@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-05 15:45:03 UTC Pre-commit check linux-x86_64-release-asan for 5b12eb9 has started.
⚪ 2026-10-05 15:46:04 UTC Artifacts will be uploaded here
⚪ 2026-10-05 15:48:28 UTC ya make is running...
🔴 2026-10-05 15:49:39 UTC Build failed, see the logs. Also see fail summary

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-05 15:52:24 UTC Pre-commit check linux-x86_64-relwithdebinfo for 5b12eb9 has started.
⚪ 2026-10-05 15:53:11 UTC Artifacts will be uploaded here
⚪ 2026-10-05 15:56:03 UTC ya make is running...
🔴 2026-10-05 15:59:02 UTC Build failed, see the logs. Also see fail summary

@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-05 20:41:05 UTC Pre-commit check linux-x86_64-release-asan for 4c7edfa has started.
⚪ 2026-10-05 20:41:28 UTC Artifacts will be uploaded here
⚪ 2026-10-05 20:43:13 UTC ya make is running...
🔴 2026-10-05 20:44:27 UTC Build failed, see the logs. Also see fail summary

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-05 20:43:01 UTC Pre-commit check linux-x86_64-relwithdebinfo for 4c7edfa has started.
⚪ 2026-10-05 20:43:23 UTC Artifacts will be uploaded here
⚪ 2026-10-05 20:45:09 UTC ya make is running...
🔴 2026-10-05 20:47:39 UTC Build failed, see the logs. Also see fail summary

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-06 10:20:39 UTC Pre-commit check linux-x86_64-release-asan for 5c661e3 has started.
⚪ 2026-10-06 10:21:03 UTC Artifacts will be uploaded here
⚪ 2026-10-06 10:22:40 UTC ya make is running...
🟢 2026-10-06 10:26:20 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2026-10-06 10:26:25 UTC Build successful.

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-06 10:24:36 UTC Pre-commit check linux-x86_64-relwithdebinfo for 5c661e3 has started.
⚪ 2026-10-06 10:24:48 UTC Artifacts will be uploaded here
⚪ 2026-10-06 10:26:46 UTC ya make is running...
🟢 2026-10-06 10:35:25 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
1301 1299 0 0 2 0

🟢 2026-10-06 10:35:30 UTC Build successful.

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-06 10:52:46 UTC Pre-commit check linux-x86_64-relwithdebinfo for f1cbc39 has started.
⚪ 2026-10-06 10:52:53 UTC Artifacts will be uploaded here
⚪ 2026-10-06 10:54:40 UTC ya make is running...
🟢 2026-10-06 11:02:03 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
1301 1299 0 0 2 0

🟢 2026-10-06 11:02:08 UTC Build successful.

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-06 10:53:47 UTC Pre-commit check linux-x86_64-release-asan for f1cbc39 has started.
⚪ 2026-10-06 10:54:08 UTC Artifacts will be uploaded here
⚪ 2026-10-06 10:55:56 UTC ya make is running...
🟢 2026-10-06 10:58:55 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2026-10-06 10:59:00 UTC Build successful.

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-08 15:36:46 UTC Pre-commit check linux-x86_64-release-asan for 941c2ef has started.
⚪ 2026-10-08 15:37:08 UTC Artifacts will be uploaded here
⚪ 2026-10-08 15:38:54 UTC ya make is running...
🟢 2026-10-08 15:56:14 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2026-10-08 15:56:19 UTC Build successful.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-08 15:41:49 UTC Pre-commit check linux-x86_64-relwithdebinfo for 941c2ef has started.
⚪ 2026-10-08 15:42:10 UTC Artifacts will be uploaded here
⚪ 2026-10-08 15:43:48 UTC ya make is running...
🟢 2026-10-08 16:01:12 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
1309 1307 0 0 2 0

🟢 2026-10-08 16:01:17 UTC Build successful.

@github-actions

github-actions Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

⚪ 2026-10-09 09:35:54 UTC Pre-commit check linux-x86_64-relwithdebinfo for dc68067 has started.
⚪ 2026-10-09 09:36:04 UTC Artifacts will be uploaded here
⚪ 2026-10-09 09:37:48 UTC ya make is running...
🟢 2026-10-09 09:46:20 UTC Tests successful.

Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
1309 1307 0 0 2 0

🟢 2026-10-09 09:46:25 UTC Build successful.

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

✅ Documentation build

Revision built successfully
Revision preview link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants