erlang
new documentation is an example of UI/UX degradation relative to the old documentation
new documentation is an example of UI/UX degradation relative to the old documentation
looks like idea to make updates just for updates - make "fresh" but not for make better - so we get worse in result..
Describe the bug
somebody cannot to decide what links type to use in new documentation -- with ".html" ending or without --
so we can see mixed links on page -- with ".html" ending and without it --
just check it --
https://www.erlang.org/doc/apps/erts/erl_nif#enif_release_binary
https://www.erlang.org/doc/apps/erts/erl_nif.html#enif_release_binary
on the left sidebar links path with ".html" ending,
and on the center column links without ".html" ending
so we got page that just again and again slowly reloads with slow mobile internet
(war in europe is reality, and not everybody has 1Gbit/sec at this moment, huh?)
nice! thank for "better" update..
there are few ways what to do --
- use 1 absolute path at all
- use 2 paths with relative links
- do nothing for fix it -- just make erlang documentation worse and worse..
.
another scary moment (in addition to collapsed spoilers in left sidebar)
we can see at
https://www.erlang.org/doc/system/list_comprehensions.html
[X || X <:- [1,2,a,3,4,b,5,6], X > 3].
[a,4,b,5,6]
I have no idea why documentation was changed for looks like "<-" was replaced by "<:-"
(just compare pages from erl25-26 with the latest documentation page)
better will be begin page from
"there are two operators like <- and <:- for generators-comprehensions, lets see the difference ..."
because you just add new operator, not replace operator;
because
> [X || X <- [1,2,a,3,4,b,5,6], X > 3].
[a,4,b,5,6]
there are no reason for type additional : symbol for programs where nothing changes..
To Reproduce any browser
Expected behavior just open page - scroll down and read like in old documnetation, without additional clicks onto left sidebar for open spoilers, without stupid refreshes the same page etc...
Affected versions "new" documentation -- next after (last good one) erl26 -- latest etc
Additional context
with hope that this "better" will be fixed and really becomes better ..
ty
Thanks for raising this issue! I'm fairly certain that the link issue is caused by ex_doc since we don't type out links ourselves in the source. I'll raise an issue over there.
because you just add new operator, not replace operator;
We want people to reach for <:- first since it's less prone to error[^1], so we changed the documentation to prefer it. We want to replace <- with <:- wherever the filtering behavior is not desired to make it "the new default."
[^1]: Consider [Foo || #bar{foo=Foo} <- Flurb], this will silently filter out anything that isn't #bar{}!
ok, what about this - in old documentation we do not need additional clicks for navigation to function+description that we interested in ?
in new documentation additional clicks required.. scary new docs .. (( dislike it .. ((
in old documentation we just open module page - https://www.erlang.org/docs/26/man/erlang and scroll down - at left we see function about what we want to read - for example, atom_to_binary/1 we can click this function name at left and page scrolls to func' description that is all -- easy and nice
and what we see in new documentation? definitely not the same easy.. not so easy in new documentation -- we open module with function we have interesting - https://www.erlang.org/docs/27/apps/erts/erlang
and what next?
not see functions list, not see functions list item..
old documenation was too simple, too easy navigation, too comfortable.. unlike new documentation..