documentation
documentation copied to clipboard
temporalio
Add Learn link; change log -> changelog
What does this PR do?
- Fixes #1415
- Uses the more familiar-to-developers spelling of "changelog"
Prefer shorter/cleaner "Changelog" over "Docs changelog" in nav. Should still be clear after you click it that it's for docs, given the header:
Sidebar:
My guess is a footer link might not meet @afitz0's desired level of discoverability
@djmagee and I followed up on style guidance and there are plenty of examples going both ways for different reasons - and we settled on keeping it as "Docs change log" specifically - keep "Docs" there so its clear it is not a Product change log.
Did you consider mental load? My sense is changelog is more familiar for developers, and due to that and it being one word, I think it's easier to see/comprehend in a nav list.
Re: prefixing with Docs in nav, I think 1 word is easier to see/comprehend than 3 words, and IMO [easier-to-see/comprehend for everyone] is more important than [some people mistakenly click it only to learn it's the Docs changelog].
RE: Learn link. As a user, Documentation and Learning are nearly identical to me, and putting Learn in the collection of footer links feels a little like shipping an org chart. (That is to say, @lorensr is right, adding Learn to the footer doesn't feel like increasing discoverability to me.)
If there won't be header real estate, an alternative is what Apollo does: list the tutorials in the left nav of docs, and they take you to their separate Odyssey learning platform:
https://www.apollographql.com/docs/
Picking up the learn link change here: https://github.com/temporalio/documentation/pull/1575
Down to keep this alive if we go with "Docs changelog" for the header nav label and sidebar label and keep it focused on the changelog
Basically I want to keep any non docs.temporal.io links in the footer (already updated them per this and other prs) -
LMK -