From nobody Mon Nov 22 22:16:05 2021 X-Original-To: freebsd-doc@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id BE77F18AED7F for ; Mon, 22 Nov 2021 22:16:12 +0000 (UTC) (envelope-from rockyhotas@firemail.cc) Received: from mail.cock.li (mail.cock.li [37.120.193.124]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 4HyhSC2rxrz4RSJ; Mon, 22 Nov 2021 22:16:10 +0000 (UTC) (envelope-from rockyhotas@firemail.cc) Date: Mon, 22 Nov 2021 23:16:05 +0100 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=firemail.cc; s=mail; t=1637619368; bh=uE8HZ//+vlyAwYTdECVhxVVXUbVcCziC+wFeczc/MTA=; h=Date:From:To:Cc:Subject:Reply-To:References:In-Reply-To:From; b=Xl4sWCYeNEpITJ0wRBhUVQ7U1eLGIof1GFFc+xfPqn623j1n0PzAEwnvCsiHS8geK soxDJHp/iPjVsiTaH3gzkFZ4e1Q01405HC4jqoM4JUxnLiXC1zrE6tlv1z7+1xEAWN npQjGWDSJwfB0h+69Mv4fCQqMSK2mps5J21KR3uZLEonVQDH1m2A5Aw0OGSwZYQu1R /JBH2CLVmjgParBstBQE+W+hqGP+Kh0E/aYMrwo0geof45UtirgCXO5K7S1tYQHLfg uQf1zQLhK6LwFLsH94oMasOIcQunr6TaJ1irUjbBGuzBn2a5oyYvP90LUEF/tp/0EB ZtSQKj4K7cUVQ== From: Rocky Hotas To: Sergio Carlavilla Cc: freebsd-doc@FreeBSD.org Subject: Re: FreeBSD Documentation Portal status and review request Message-ID: <20211122221605.6yvfnuhpg75gthgy@delpotro> Reply-To: Rocky Hotas References: List-Id: Documentation project List-Archive: https://lists.freebsd.org/archives/freebsd-doc List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-doc@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: X-Rspamd-Queue-Id: 4HyhSC2rxrz4RSJ X-Spamd-Bar: - Authentication-Results: mx1.freebsd.org; dkim=pass header.d=firemail.cc header.s=mail header.b=Xl4sWCYe; dmarc=none; spf=pass (mx1.freebsd.org: domain of rockyhotas@firemail.cc designates 37.120.193.124 as permitted sender) smtp.mailfrom=rockyhotas@firemail.cc X-Spamd-Result: default: False [-1.00 / 15.00]; HAS_REPLYTO(0.00)[rockyhotas@firemail.cc]; ARC_NA(0.00)[]; R_DKIM_ALLOW(-0.20)[firemail.cc:s=mail]; REPLYTO_EQ_FROM(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; R_SPF_ALLOW(-0.20)[+ip4:37.120.193.120/29]; MIME_GOOD(-0.10)[text/plain]; DMARC_NA(0.00)[firemail.cc]; NEURAL_HAM_LONG(-1.00)[-1.000]; NEURAL_SPAM_SHORT(1.00)[0.999]; NEURAL_HAM_MEDIUM(-1.00)[-1.000]; DKIM_TRACE(0.00)[firemail.cc:+]; RCPT_COUNT_TWO(0.00)[2]; RCVD_COUNT_ZERO(0.00)[0]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; MID_RHS_NOT_FQDN(0.50)[]; ASN(0.00)[asn:9009, ipnet:37.120.193.0/24, country:GB]; RWL_MAILSPIKE_POSSIBLE(0.00)[37.120.193.124:from] X-Spam: Yes X-ThisMailContainsUnwantedMimeParts: N On nov 21 17:31, Sergio Carlavilla wrote: [...] > For example a local search using Algolia[2] as Hugo[3] or > AsciiDoctor[4] does. Algolia provides a free version for Open Source > projects[5]. > And the dark theme. > > Apart from that, you can see the new Documentation Portal here[6]. First, thank you for the updates and for this huge work. I do not know very much the above tools, so I can only give a personal opinion about the appearance of Documentation Portal. This is of course very subjective. - The beginning page is very clear and the whole space looks well organized with the rectangles: all the available items are clearly and quickly recognizable. - The contents pages are amazing! The actual text width is less than the current version and this improves readability. - A dark theme would be very useful (and also very cool!). - The font for titles of chapters and sections is too much bold. Lower level subsections, like `14.2.1. Preventing Logins', are instead ok. - The whole page uses sans-serif fonts, except for the `Note', `Warning' and similar panels. This seems mismatched. Why not to use a sans-serif font also there? - There is a very high contrast with the background when using the black-filled circles with numbers in a code block. Maybe replace black with a different color? - In the side panels, the vertical spacing between lines is excessive, in particular inside the same group (the lines with the sections of a chapter, for example). - In the main text, the font size could be just a little bit smaller (1 pt or even 0.5 pt), or tunable by the user. The horizontal spacing of the font sometimes looks excessive: too empty space between letters or words. - The `Download PDF' and `Edit this page' links currently are not working. - The typewriter font used in-line and also in the emulated black screen rectangles is too little in comparison to the main text font. The overall result is, however, already very pleasing and comfortable. So, congratulations :)! Bye! Rocky