WebKit / Documentation

Documentation for the WebKit project, hosted at https://docs.webkit.org.
https://docs.webkit.org
63 stars 24 forks source link

Add prominent https://webkit.org/ link to top page #66

Open sideshowbarker opened 1 year ago

sideshowbarker commented 1 year ago
Add prominent https://webkit.org/ link to top page

A developer/reader coming in to the https://docs.webkit.org/ site would
likely find it pretty useful to also browse directly to the top of the
https://webkit.org/ site and explore all the other information about WebKit
which that site provides.

But the existing https://docs.webkit.org/ site doesn’t include any link
directly to the top of the https://webkit.org/ site.

Among the specific things linked to on the https://webkit.org/ site,
developers are likely to find the Feature Status tab in the top menu
to be useful — since it includes links to the Standards Positions and
CSS Features pages, which docs.webkit.org doesn’t link to (and
probably doesn’t need to).

See also https://commits.webkit.org/267977@main

* docs/index.md: Added link to https://webkit.org/
stwrt commented 1 year ago

I am wondering if we want to instead have a link to webkit.org at the bottom (next to the github / slack links).

This way it would be easily visible from any page.

sideshowbarker commented 1 year ago

I am wondering if we want to instead have a link to webkit.org at the bottom (next to the github / slack links).

This way it would be easily visible from any page.

OK, I just now pushed a change which adds it there too — though for now just with the Safari logo.

I’m not familiar with the build/templating system at all, so I don’t know how to add an icon that’s not a fontawesome/brands icon.

I don’t know what icon other than the WebKit logo would be appropriate. But since docs.webkit.org also uses the WebKit logo, I’d wonder if just using the WebKit logo would make users assume the icon/image link is just a “home” link to the docs.webkit.org site rather than the webkit.org site.

Regardless, the icon/image link seems like maybe a too-subtle way, just on its own, to direct user attention to the webkit.org site. So I don’t think it needs to be an either/or — it seems like the docs.webkit.org site could have both the prose link at the top of the home page and the icon/image link in the footer. (That is, what’s now in the current patch in this PR branch.)

But if you think only the icon/image link in the footer is sufficient, I’m happy to update the patch.

JonWBedard commented 1 year ago

OK, I just now pushed a change which adds it there too — though for now just with the Safari logo.

I know we don't want to link webkit.org to the Safari logo like that. The relationship between Safari and WebKit already confuses folks, we definitely want to keep webkit.org under the WebKit rather than Safari brand.

karlcow commented 1 year ago

I know we don't want to link webkit.org to the Safari logo like that. The relationship between Safari and WebKit already confuses folks, we definitely want to keep webkit.org under the WebKit rather than Safari brand.

Probably yes. There is a request it seems for a Font Awesome Icon for WebKit. https://github.com/FortAwesome/Font-Awesome/issues/4937