Skip to content

Daml language examples, fixed internal references and reordering of modules#585

Open
JavierStark wants to merge 6 commits into
canton-network:mainfrom
JavierStark:daml-doc-fixes
Open

Daml language examples, fixed internal references and reordering of modules#585
JavierStark wants to merge 6 commits into
canton-network:mainfrom
JavierStark:daml-doc-fixes

Conversation

@JavierStark

Copy link
Copy Markdown
  • Added the examples from digital-asset/daml/sdk/docs/source/sdk/tutorials/smart-contracts/daml/daml-intro-data/daml into Language Fundamentals docs section.
  • Changed markdown code snippet from bash to haskell in two locations where it was not properly formatting the code

@JavierStark

JavierStark commented May 20, 2026

Copy link
Copy Markdown
Author

I also proposed a new order for the navigation of Module 3 as some modules make reference to other modules later in the section and following them in order hard.

…proved clarity and repaired broken internal references
@JavierStark JavierStark changed the title Examples in Daml Language Fundamentals Daml language examples, fixed internal references and reordering of modules May 20, 2026
@8bitpal 8bitpal requested review from Jatinp26 and shreyas-da June 3, 2026 08:33
@Jatinp26

Copy link
Copy Markdown
Collaborator

Overall, @JavierStark
would love to understand the impact of doing vs not making these changes as most of it seems rephrasing.

@JavierStark

Copy link
Copy Markdown
Author

a689d20 is indeed a rephrasing that change the way references in the text are presented. As someone who has read through the documentation and spent a long time trying to learn and understand the concepts, having clear references would have helped me a lot. Most of the original text is clearly a copy and paste from an old documentation so they were referencing stuff that wasn't there or at least not in the correct location.

b18eb46 goes along the other one as some sections have "dependencies" in others, so respecting that partial order would help for people reading all sections in the displayed order.

0c9e77f is not a rephrasing, it adds styling and format to those DAML snippets that were plain white and unstyled before because of being in bash code snippets.

8f6544b adds examples that were just missing and referencing to files not directly available in the documentation to the reader.

Overall these changes are clearly not huge but I believe they are necessary to make the documentation professional, clear and out of the WIP state. I am trying to do my bit for the next reader to have a better experience and a complete documentation.

@Jatinp26

Copy link
Copy Markdown
Collaborator

Thanks @JavierStark
This was helpful, appreciate your contribution in the docs, I'll review changes accordingly and merge after validating the examples.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants