Request for Feedback: Perl Documentation Site

The official Perl documentation site at https://perldoc.perl.org was recently overhauled. Independently, I put together a reimagined documentation site that would be hosted at https://perldoc.pl. In the interest of providing a documentation site that best serves the needs of the Perl community, we need your feedback. Please give both sites a try, in-depth if you want, or just how you would most commonly use the site. What do you like about the design or the functionality of each site? What is missing or can be improved? Any feedback regarding what you want from the Perl documentation site is helpful and appreciated. Please leave comments here or in the linked posts by Monday Nov 18th.

blogs.perl.org comments

Reddit comments

Comment on Request for Feedback: Perl Documentation Site

Replies are listed 'Best First'.
Re: Request for Feedback: Perl Documentation Site by haukex (Archbishop) on Oct 28, 2019 at 08:23 UTC
I prefer the design of `perldoc.pl` a little more over the `perldoc.perl.org` redesigned look. One thing I miss from both sites is the quick navigation menu on the left - unfortunately, my suggestion to bring it back to `perldoc.perl.org` was rejected without explanation. If `perldoc.pl` had such a menu, then it would become my preferred documentation site. Update: Actually, `perldoc.perl.org` is only my "preferred" site because PerlMonks `[doc://]` links to that, and when my brain is on autopilot I still type `perldoc.perl.org` in the address bar. Plus I remember reading somewhere that `.pl` domains are blocked in some countries - so I would welcome `perldoc.pl` somewhere beneath the `perl.org` domain `:-)`	[reply] [d/l] [select]
Re: Request for Feedback: Perl Documentation Site by Eily (Monsignor) on Oct 28, 2019 at 13:54 UTC
One of the reasons I use https://perldoc.pl rather than https://perldoc.perl.org is because the URL of the former have the same format as [doc://] tags on perlmonks. Eg if I want to link to the Range Operators (`[doc://perlop#Range-Operators]`) I just have to copy the end of https://perldoc.pl/perlop#Range-Operators, which doesn't work with the extra .html extension in https://perldoc.perl.org/perlop.html#Range-Operators. The permalink beside section titles in https://perldoc.pl also helps, I don't need to get back to the top of the page to copy the link.	[reply] [d/l]
Re: Request for Feedback: Perl Documentation Site by swmcd (Initiate) on Nov 11, 2019 at 19:48 UTC
First, I very much dislike the new perdoc.perl.org design - It's full of eye-candy and wasted screen space. - It has a deep navigation hierarchy: you have to click and click and click to get where you're going. perldoc.pl suits me much better - It's text-only. - It's big and flat. I can get the whole thing at once and scroll to find what I need. Couple of things on perldoc.pl - The code boxes are low-contrast and hard to read on my screen. Not sure why this is. The font is very lightweight; maybe needs to be heavier. - The code boxes render in courier. Courier was designed for typewriters. For better readability, consider using a modern fixed-width font that was designed for screens. (Or just specify "fixed" and let the browser choose.) - I need the row of index letters at the top of the perlfunc page that jump to the functions that start with that letter. I know they aren't in the POD, but scrolling through a page that big is awkward.	[reply]
Re: Request for Feedback: Perl Documentation Site by duelafn (Parson) on Oct 28, 2019 at 10:55 UTC
The landing page of perldoc.perl.org is friendlier. On both sites, the dropdown menus are non-functional to users with JavaScript disabled. Good Day, Dean	[reply]
Re: Request for Feedback: Perl Documentation Site by Anonymous Monk on Dec 22, 2019 at 06:05 UTC
What is missing or can be improved? Why would someone decide to downgrade the official perldocs at perldoc.perl.org by eliminating the PDF? It makes no sense. They should adding features, not taking them away. https://perldoc.perl.org/corelist.pdf	[reply]
Re^2: Request for Feedback: Perl Documentation Site by Anonymous Monk on Jan 14, 2020 at 18:04 UTC
I actually had no idea that existed (apparently everyone else has also forgotten). Is this simply a PDF version of each page? It would be a reasonably doable feature to add to perldoc.pl. -Grinnz	[reply]
Re^3: Request for Feedback: Perl Documentation Site by marto (Cardinal) on Jan 14, 2020 at 18:45 UTC
FWIW I still prefer perldoc.pl to the official online docs, it works well on my small screen netbook.	[reply]
Re^3: Request for Feedback: Perl Documentation Site by Anonymous Monk on Jan 15, 2020 at 02:52 UTC
Is this simply a PDF version of each page? Yes, every page had a PDF link, such as this: https://web.archive.org/web/20150906224303/https://perldoc.perl.org/corelist.pdf I handle it locally with pod2pdf. Thank you for your good work .	[reply]

Back to Perl News