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

Remarks about the preview version of the Blazorise documentation #2856

Closed
stsrki opened this issue Aug 31, 2021 Discussed in #2854 · 0 comments · Fixed by #2732
Closed

Remarks about the preview version of the Blazorise documentation #2856

stsrki opened this issue Aug 31, 2021 Discussed in #2854 · 0 comments · Fixed by #2732
Assignees
Labels
Area: Documentation Something is missing in the documentation.
Milestone

Comments

@stsrki
Copy link
Collaborator

stsrki commented Aug 31, 2021

Discussed in #2854

Originally posted by iwis August 31, 2021
I have a few remarks about the new version of the documentation (https://preview.blazorise.com/docs) :

  1. Horizontal menu:
    • Make it smaller or not sticky
      Reasons: 1. more text will fit on a web page; 2. current documentation doesn't have sticky menu; Vuetify and Bootstrap docs have a sticky menu but it is smaller.
  2. Vertical menu:
    • Fit more items on a computer screen
      Reasons: 1. component searching will be easier; 2. there are more menu items on a screen in Bootstrap, Vuetify, and the current Blazorise documentation.
  3. Sample code (a div with the blazorise-codeblock CSS class):
    • Reduce the font size and/or the line height
      Reasons: 1. more text will fit on a web page; 2. Bootstrap and Vuetify docs use smaller fonts.
    • The code should be able to occupy the entire black window, currently it cannot reach its right edge
      Reasons: 1. it doesn't look elegant now; 2. more text will fit on a web page; 3. Bootstrap and Vuetify docs don't have this problem.
    • Reduce the bottom padding of the black window (technically it is the bottom margin of the <pre> tag, equal to 1 rem)
      Reasons: 1. the bottom padding is larger than the top padding, which doesn't look good; 2. more text will fit on a web page;
      3. Boostrap, Vuetify and the current Blazorise docs don't have this problem.
    • (probably controversial) Put opening brackets in the same line (https://en.wikipedia.org/wiki/Indentation_style#Variant:_Stroustrup)
      Reasons: 1. more text will fit on a web page; 2. opening brackets are in the same line in JavaScript code in Vuetify and Bootstrap docs
    • I like a light background more - like in Vuetify or Boostrap docs, although it may be a matter of taste.
  4. Table describing attributes
    • I don't like that the first three columns of a table have the same red font. In Vuetify documentation, fonts of these columns are different - the name column stands out because it is the most important.

Of course some or most of remarks can be a matter of taste!

@stsrki stsrki added the Area: Documentation Something is missing in the documentation. label Aug 31, 2021
@stsrki stsrki added this to the 0.9.5 milestone Aug 31, 2021
@stsrki stsrki moved this to ✔ Done in Development Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Something is missing in the documentation.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants