-
Notifications
You must be signed in to change notification settings - Fork 206
Introduce an "Edit this page" link #919
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
A live preview of this PR will be available at the URL(s) below. https://pr919-613d21e---lit-dev-5ftespv5na-uc.a.run.app/ |
I feel like the edit button is a bit too prominent. Given that our pages are mostly flat, and this button looks like a raised FAB, in the Material paradigm this would be the primary action of a page. Do we have some other examples of an edit link that's more subtle? Could maybe also combine this with a "lasted updated on..." text? (I know that may be harder because we need to look at file write times, but maybe 11ty already pipes that through?) |
Most other call to edits I've seen are a bit more subtle, and require scrolling all the way to the bottom of the page. Last updated probably needs to grab the last git commit date for the file which seems extra. |
Can create a link at the bottom of the page. Also "last edited x" we added it to the articles but I think only because that info can actually get stale which I don't think is necessarily the case for the docs. |
The bottom of docs pages looks a little weird to me currently, with the page content background just running right into the footer. Can we fix this up a little at the same time? ie, add a bit of margin so that the bottom of the content area looks like the top, then put the edit link below: |
613d21e
to
4927baa
Compare
Updated to a link at the bottom of the page. LMK what you think. Esp about the text e.g. should it be |
How about putting the link inside the white part of the page, above the table of contents? That's how Vue does it: https://vuejs.org/guide/reusability/custom-directives.html#directive-hooks I think the left aligned looks a bit better too. |
The "Edit Square" icon (square with pencil in it) (https://fonts.google.com/icons) also seems better than the "Open in New" icon used in the latest commit, since we want to suggest an "edit" action. The current icon just reads as "external link" to me. |
That looks pretty good there. I like the left alignment and "Edit this page on GitHub" text too. |
Did the changes. Also added justin's suggestion for the padding on the docs |
quick ping on this to move up your inbox for tomorrow |
Fixes #450
There is now a link at the bottom of every doc and article Links to test:
https://pr919-f93c133---lit-dev-5ftespv5na-uc.a.run.app//docs/
https://pr919-f93c133---lit-dev-5ftespv5na-uc.a.run.app//articles/lit-for-polymer-users