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

Font-weight in docs makes paragraphs tough to read #6800

Open
faraazahmad opened this issue Jun 25, 2019 · 2 comments
Open

Font-weight in docs makes paragraphs tough to read #6800

faraazahmad opened this issue Jun 25, 2019 · 2 comments
Labels
docs Related to the content of the documentation itself (i.e. not any particular feature on sailsjs.com) what do you think? Community feedback requested

Comments

@faraazahmad
Copy link

Node version: N/A
Sails version (sails): all
ORM hook version (sails-hook-orm): N/A
Sockets hook version (sails-hook-sockets): N/A
Organics hook version (sails-hook-organics): N/A
Grunt hook version (sails-hook-grunt): N/A
Uploads hook version (sails-hook-uploads): N/A
DB adapter & version (e.g. sails-mysql@5.55.5): N/A
Skipper adapter & version (e.g. skipper-s3@5.55.5): N/A


The paragraphs in the docs have font-weight:300 which can make them tough to read (I almost gave up Sails because of that), increasing the font-weight can make them more readable and accessible.

Original:
image

Increased font-weight:
image

Open for discussion

@sailsbot
Copy link

@faraazahmad Thanks for posting! We'll take a look as soon as possible.

In the mean time, there are a few ways you can help speed things along:

  • look for a workaround. (Even if it's just temporary, sharing your solution can save someone else a lot of time and effort.)
  • tell us why this issue is important to you and your team. What are you trying to accomplish? (Submissions with a little bit of human context tend to be easier to understand and faster to resolve.)
  • make sure you've provided clear instructions on how to reproduce the bug from a clean install.
  • double-check that you've provided all of the requested version and dependency information. (Some of this info might seem irrelevant at first, like which database adapter you're using, but we ask that you include it anyway. Oftentimes an issue is caused by a confluence of unexpected factors, and it can save everybody a ton of time to know all the details up front.)
  • read the code of conduct.
  • if appropriate, ask your business to sponsor your issue. (Open source is our passion, and our core maintainers volunteer many of their nights and weekends working on Sails. But you only get so many nights and weekends in life, and stuff gets done a lot faster when you can work on it during normal daylight hours.)
  • let us know if you are using a 3rd party plugin; whether that's a database adapter, a non-standard view engine, or any other dependency maintained by someone other than our core team. (Besides the name of the 3rd party package, it helps to include the exact version you're using. If you're unsure, check out this list of all the core packages we maintain.)

Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, disclose it responsibly.

For help with questions about Sails, click here.

@johnabrams7 johnabrams7 added the docs Related to the content of the documentation itself (i.e. not any particular feature on sailsjs.com) label Jun 25, 2019
@johnabrams7
Copy link
Contributor

johnabrams7 commented Jun 25, 2019

@faraazahmad Thanks, we're currently working on updates to the docs and their layout (including font-weight) at the moment, so this feedback is much appreciated and will be taken into consideration. In the meantime, the same docs are available in the sails-docs repo with a heavier font-weight.

We welcome further input from the community for this one 👍

@johnabrams7 johnabrams7 added the what do you think? Community feedback requested label Jun 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the content of the documentation itself (i.e. not any particular feature on sailsjs.com) what do you think? Community feedback requested
Development

No branches or pull requests

3 participants