Daml language examples, fixed internal references and reordering of modules#585
Daml language examples, fixed internal references and reordering of modules#585JavierStark wants to merge 6 commits into
Conversation
JavierStark
commented
May 20, 2026
- 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
|
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
|
Overall, @JavierStark |
|
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. |
|
Thanks @JavierStark |