search

fsprojects / FSharp.Data

F# Data: Library for Data Access
https://fsprojects.github.io/FSharp.Data
Other
816 stars 288 forks source link

update docs #1370

Closed dsyme closed 3 years ago

dsyme commented 3 years ago

Fixes the issues in https://github.com/fsprojects/FSharp.Data/issues/1368

Also move some docs from non-standard markdown to standard XML

Note the fsdocs sidebar has moved the left by default. I'm also thinking we should change the default fsdocs template to position it more like DiffSharp does than all the way to the left as the default is now doing. (I'd like to keep using the FSharp.Formatting default template so we can keep making improvements there)

nhirschey commented 3 years ago

Strong second of a sidebar along the lines of the diffsharp docs template.

I’ve been meaning to raise an issue, but if you’re on a mobile browser then clicking the sidebar on the current template fills the browser window with the sidebar, and that sidebar menu that pops out is not scrollable. So it’s impossible (at least on iOS) to scroll to and click on links at the bottom of the side bar. You’re restricted to the first few items on the sidebar. In below screenshot, I can’t access anything below XML Provider.

Diffsharp has sidebar links at the top on mobile, which makes it scrollable. 6D28F68B-A623-4FDA-8211-F90C37CABBB4

dsyme commented 3 years ago

I think the problem is that the intention is that the nav bar is scrollable and fixed-location (which works on desktop). And the DiffSharp one has no hamburger on mobile

Anyway could you file an issue in FSharp.Formatting? Thanks

dsyme commented 3 years ago

Anyway could you file an issue in FSharp.Formatting? Thanks

(The same issue applied to the FSharp.Formatting site AFAIK)