search

PathOS-project / indicator_handbook

6 stars 6 forks source link

Causal intro tidying #49

Open tklebel opened 1 month ago

tklebel commented 1 month ago

Congrats for getting the intro to finally render in #47 , @vtraag!

I have three minor comments from the live version:

  1. I had a hard time finding the intro, although I knew it should be somewhere. It is only listed in the left-side menu below "introduction", where I did not see it for quite a while. Is there any way to make it more findable?
  2. Different to our preprint and manuscript, the code of the notebook is visible. This surprised me a bit, but I agree that it is nice to expose the code for reasons of transparency (although some aspects remain "hidden" in other files, such as the simulation or some helper functions). Just wanted to ask whether that was a concious decision. Relatedly, I think the code folding option might work nicely here, because it can help with reading flow but still shows code on demand.
  3. Lastly, I'm not too keen on the font our theme uses for code. It is not monospaced, and certain code elements look particularly weird (<-, %>%). Is there an easy way to change that?
vtraag commented 1 month ago

Congrats for getting the intro to finally render in #47 , @vtraag!

Thanks!

  1. I had a hard time finding the intro, although I knew it should be somewhere. It is only listed in the left-side menu below "introduction", where I did not see it for quite a while. Is there any way to make it more findable?

Yes, happy to include it elsewhere! All sections have their navigation at the left side. Perhaps the "introduction" label make it difficult to find? I thought it would be most fitting there. What would you suggest as an alternative?

  1. Different to our preprint and manuscript, the code of the notebook is visible. This surprised me a bit, but I agree that it is nice to expose the code for reasons of transparency (although some aspects remain "hidden" in other files, such as the simulation or some helper functions). Just wanted to ask whether that was a concious decision. Relatedly, I think the code folding option might work nicely here, because it can help with reading flow but still shows code on demand.

Yes, I only noticed this later. Some of the code should not be shown indeed, and I think only the code that we explicitly want to show. I haven't yet looked at this in detail. If you have suggestions for how to explicitly include code sections that we do want to include and exclude others, let me know!

  1. Lastly, I'm not too keen on the font our theme uses for code. It is not monospaced, and certain code elements look particularly weird (<-, %>%). Is there an easy way to change that?

Yes, this needs improvement, but only on some platforms (on Firefox on Ubuntu it looks fine, see below, on my phone not). Not sure why these difference appear, I need to look into it.

image

There's also some other styling issues still (#15) that should also be corrected.