Skip to content

Track external snippet wrapper paths that still fail extraction #601

@danielporterda

Description

@danielporterda

Completed successfully

Wrapper repo Result
cn-quickstart Processing complete: 165 succeeded, 0 failed
daml-shell Processing complete: 20 succeeded, 0 failed
scribe Processing complete: 22 succeeded, 0 failed

Completed but suspicious

Wrapper repo Result Follow-up
daml-finance Processing complete: 0 succeeded, 0 failed The wrapper completes, but the config currently extracts no snippets. Confirm whether this repo should have a non-empty snippet list or be removed from the supported wrapper list.

Does not complete successfully

Wrapper repo Observed result Failure shape
canton Processing complete: 360 succeeded, 56 failed Several generated JSON selectors are stale. Examples: party_replication-* expects indices beyond array length 5; namespace_key-* expects indices from an empty array; sdk/tutorials/app-dev/external_signing_onboarding.json is missing.
dpm Processing complete: 2 succeeded, 5 failed Config drift against source docs. One snippet points past EOF in docs/src/public/configuration.rst; four snippets reference missing docs/src/public/dpm-components.rst.
daml Processing complete: 1 succeeded, 1 failed Marker drift: reference-daml-code-snippets-reference-start-template-let-snippet cannot find -- start template let snippet.
splice Processing complete: 34 succeeded, 4 failed Config references removed or moved files: docs/src/sv_operator/sv_major_upgrade.rst and docs/src/validator_operator/validator_major_upgrades.rst.
wallet-gateway Processing complete: 34 succeeded, 41 failed The wallet config still points at docs/wallet-integration-guide/examples/..., but those files are not present in the current wallet repo checkout.
splice-wallet-kernel Processing complete: 34 succeeded, 41 failed Same underlying config as wallet-gateway; same missing docs/wallet-integration-guide/examples/... paths.

Notes

  • The wrapper wiring itself works for these paths: it finds the config, copies scripts/generateOutputDocs.js or .cjs, and invokes the helper in the source checkout.
  • The failing paths appear to be snippet-config/source-content drift, not wrapper argument parsing issues.
  • wallet-gateway and splice-wallet-kernel are aliases over the same splice-wallet-kernel-snippet-list-remote.json config. GitHub redirects the old hyperledger-labs/splice-wallet-kernel repo to canton-network/wallet, so the follow-up should decide whether to update this config for the current wallet repo layout or retire the stale entries.
  • Several runs print a local shell warning from /Users/danielporter/.bash_profile about (I)_direnv_hook; that warning did not determine pass/fail here because successful repos printed it too.

Proposed acceptance criteria

  • Each supported wrapper repo either completes with 0 failed or is intentionally removed/marked unsupported.
  • Stale config entries are updated to current source paths/markers/JSON indices, or deleted if the referenced snippet source no longer exists.
  • daml-finance is clarified: either add real snippet entries or remove it from the supported list.

Context

PR #590 added the generate:external-snippets wrapper so snippet extraction can be started from cf-docs with one command. After the merge, I reran the wrapper against the existing local source checkouts to identify which repository codepaths still do not complete successfully after the wrapper has copied the helper/config into the source repo.

Tested from canton-network/cf-docs main at c0eff73c on 2026-05-21.

Command pattern used:

direnv exec . npm run generate:external-snippets -- <repo> --source-dir <local-source-checkout> --min-free-gb 0 --quiet

For Canton, I also ran the extraction phase with --skip-prepare because generated docs-open/target/snippet_json_data/ files already existed from the prior docs-open / generateSphinxSnippets run and the goal here was to isolate extraction/config failures.

Source checkout commits used:

Source checkout Commit
canton 268d267439
cn-quickstart 5327209
dpm a4c9110
daml 0030f9c821
daml-finance 155f931b
daml-shell 8b355e9
scribe 9066c817
splice 889595d95
splice-wallet-kernel / wallet repo fd1b4b3e

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions