Add Daml code-snippet modules for Canton Network documentation#1
Open
Add Daml code-snippet modules for Canton Network documentation#1
Conversation
29 Daml code snippets from docs.canton.network wrapped into 15 compilable modules in sdk/docs/source/sdk/docs-canton-network/code-snippets/. Added daml_test Bazel target (docs-canton-network-daml-test) in BUILD.bazel. All modules compile successfully with dpm build (SDK 3.4.10).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
15 compilable Daml modules wrapping 29 code snippets from docs.canton.network. These ensure that Daml code examples shown in the documentation are compilation-checked by the existing
daml_testinfrastructure.What's included
.damlmodules insdk/docs/source/sdk/docs-canton-network/code-snippets/docs-canton-network-daml-test) added tosdk/docs/BUILD.bazeldaml.yamlfor local validation withdpm buildModule list
DocsCN_AppdevDeepDivesCompositionMultiPartyDocsCN_AppdevDeepDivesPrivacyModelDocsCN_AppdevModulesM1MentalModelsDocsCN_AppdevModulesM2MigrationChecklistDocsCN_AppdevModulesM2MultiPartyWorkflowsDocsCN_AppdevModulesM2SmartContractParadigmDocsCN_AppdevModulesM3DesignPatternsDocsCN_AppdevModulesM3LanguageFundamentalsDocsCN_AppdevModulesM4BackendDevDocsCN_AppdevModulesM7PerformanceDocsCN_AppdevReferenceDamlLanguageReferenceDocsCN_AppdevTroubleshootingGuideDevelopmentIssuesDocsCN_OverviewLearnLedgerModelDocsCN_OverviewLearnPrivacyModelDocsCN_SdksToolsCliToolsDamlScriptHow it works
The Bazel target uses the same pattern as existing doc snippet tests:
New
.damlfiles added tocode-snippets/are auto-discovered by the glob.Validation
All modules compile successfully with
dpm build(SDK 3.4.10). Fragment snippets (choice bodies, expressions) are included as comments within wrapper templates for documentation traceability.