[slf4j-dev] [JIRA] Updates for SLF4J-587: Website: Misleading reference to user manual

[slf4j developers list]

SLF4J / SLF4J-587 [Open]
Website: Misleading reference to user manual

==============================

Here's what changed in this issue in the last few minutes.

This issue has been created
This issue is now assigned to you.


View or comment on issue using this link
https://jira.qos.ch/browse/SLF4J-587

==============================
 Issue created
------------------------------

Philippe Cloutier created this issue on 02/May/23 17:40

Summary:              Website: Misleading reference to user manual
Issue Type:           Bug
Assignee:             SLF4J developers list
Created:              02/May/23 17:40
Priority:             Trivial
Reporter:             Philippe Cloutier
Severity:             trivial
Description:
  The second paragraph of [the homepage|https://www.slf4j.org/] reads:
  ??Before you start using SLF4J, we highly recommend that you read the two-page SLF4J user manual.??
  
  The "two-page" qualifier convinced me to follow the recommendation and go to [the user manual|https://www.slf4j.org/manual.html]. But halfway through reading it, I realized it was much longer than I had expected. In my browser, on a monitor much bigger than average with the viewport occupying 2560x1674 pixels, at default zoom, the user manual's content is more than 7-page-long. While there may exist a screen which fits that manual in less than 3 pages, I assume the addition of content like _Salient historical changes_ and - more importantly - the _Fluent Logging API_ section has made the paragraph outdated, to the point of being misleading at this point.
  
  The user manual remains definitely useful and suggesting it remains a good idea, but the paragraph should be improved. I suggest:
   # to drop the "two-page" qualifier or replace it with something vaguer like "concise"
   # to clarify what is meant by "Before you start using SLF4J". Perhaps replace with "Before you adopt SLF4J"
   # perhaps just "recommend" reading rather than "highly recommend" it


==============================
 This message was sent by Atlassian Jira (v9.6.0#960000-sha1:a3ee8af)