Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve default styling and top-level content layout #34

Open
dsyme opened this issue Aug 1, 2020 · 2 comments
Open

Improve default styling and top-level content layout #34

dsyme opened this issue Aug 1, 2020 · 2 comments

Comments

@dsyme
Copy link
Contributor

dsyme commented Aug 1, 2020

As noted by @baronfel in #27, the default styling and top-level layout needs improvement.

What is here is the current default styling for FSharp.Formatting using the standard _template.html, which is tight for iteration but we can do better. If necessary we can add a _template.html or fsdocs-styles.css in here though to be honest I'd love it if we could make the default FSharp.Formatting _template.html good enough to be both configurable for the needs of this repo and to satisfy and please.

Please make a note below everything that you do/don't like about the current design, layout and content. If possible give specific (preferably visual) examples of what you want improved, and, if possible, give links to how those improvements might be made in terms of CSS improvements and JS framework changes.

The things I've noticed so far:

  • The scrollbar on the left appears even if its not needed. This is I believe because of horizontal overflow.

  • Agreed with @baronfel the basic look is very sparse (though I quite enjoyed browsing it on my phone earlier). Also this is tricky as the site is not like most other doc sites as it is only doing FSHarp.Core API docs and is not a general tech doc site.

  • The repetition of parameter XML doc with parameter types is a bit painful (this is an F#F issue)

  • There is a glitch iwhere function names and parameters run together for active patterns and some module functions

  • Agreed with @cartermp that the link on the logo should go to https://fsharp.org

@dsyme dsyme added fsdocs This is really an issue in FSharp.Formatting and removed fsdocs This is really an issue in FSharp.Formatting labels Aug 1, 2020
@dsyme dsyme changed the title Improve default styling and top-level content layout (both here and in F#F) Improve default styling and top-level content layout Aug 2, 2020
@dsyme
Copy link
Contributor Author

dsyme commented Aug 2, 2020

@cartermp @Krzysztof-Cieslak @baronfel

I copied over the default templates and styling and you guys can hack away on the design, fonts, JS frameworks used and so on to your heart's content.

Once you're done we can copy the results back into FSF as a default template

You may need to improve the style tagging in the generated HTML. I'd like FSF to document the style tags emitted and make sure we don't change them too much

@dsyme
Copy link
Contributor Author

dsyme commented Aug 2, 2020

I've also added a front page which I think greatly helps the site, though it all needs good styling

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

No branches or pull requests

1 participant