TuringLang / docs

Documentation and tutorials for the Turing language
https://turinglang.org/docs/tutorials/docs-00-getting-started/
MIT License
225 stars 97 forks source link

fixed minor issues #448

Closed shravanngoswamii closed 1 month ago

shravanngoswamii commented 1 month ago

also fix these in this pr:

    • [x] @yebai Should I change this diagram to Graphviz: https://turinglang.org/TuringTutorials/tutorials/docs-04-for-developers-abstractmcmc-turing/#states

      Old Image Diagram New with Mermaid Code
      Mermaid Diagram
      ```{mermaid}
      graph TD
        spl["spl<br/>Sampler<br/>&lt;:AbstractSampler"]:::leftAlign
        state["spl.state<br/>State<br/>&lt;:AbstractSamplerState"]:::leftAlign
        alg["spl.alg<br/>Algorithm<br/>&lt;:InferenceAlgorithm"]:::leftAlign
        vi["spl.state.vi<br/>VarInfo<br/>&lt;:AbstractVarInfo"]:::leftAlign
        placeholder1["..."]:::placeholder
        placeholder2["..."]:::placeholder
        placeholder3["..."]:::placeholder
        placeholder4["..."]:::placeholder
      
        spl --> state
        spl --> alg
        spl --> placeholder1
      
        state --> vi
        state --> placeholder2
      
        alg --> placeholder3
        placeholder1 --> placeholder4
      
        classDef leftAlign text-align:left;
        classDef placeholder width:100px;
yebai commented 1 month ago

@yebai Should I change this diagram to Graphviz: https://turinglang.org/TuringTutorials/tutorials/docs-04-for-developers-abstractmcmc-turing/#states

Both Mermaid and GraphViz work; one possible advantage of GraphViz is that it supports Quarto's tex workflow, which we might do later.

shravanngoswamii commented 1 month ago

@yebai Should I change this diagram to Graphviz: https://turinglang.org/TuringTutorials/tutorials/docs-04-for-developers-abstractmcmc-turing/#states

Both Mermaid and GraphViz work; one possible advantage of GraphViz is that it supports Quarto's tex workflow, which we might do later.

I converted it to Graphviz too: Screenshot 2024-05-24 185519

shravanngoswamii commented 1 month ago

I can add whatever you prefer!

shravanngoswamii commented 1 month ago

@yebai If visibility of that assertion error is not an issue than this PR is good to go