Details
-
Bug
-
Resolution: Fixed
-
Trivial
-
None
-
None
-
None
-
trivial
Description
The second paragraph of the homepage 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. 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