duckdb-web icon indicating copy to clipboard operation
duckdb-web copied to clipboard

Published 20 hours ago • verified publisher icon duckdb

Add Next and Back Navigation Buttons to the Documentation

Open corwinjoy opened this issue 1 year ago • 6 comments

Add navigation buttons to the documentation as per the proposal here: https://github.com/duckdb/duckdb-web/issues/2852

Comments:

  1. I was able to get this to work pretty well but there were a couple limitations. a. The Sitemap appears twice, once at the top level and once at the beginning of the documentation. I had to pick one to get a single navigation order so I chose the Sitemap position in the left menu. b. I did not include navigation for the demo page since I think that makes no sense.

  2. I made the buttons as pretty as I know how, but I'm not all that great at graphic design. The buttons are a class in the css file so I welcome suggestions there.

  3. It might make sense to have navigation buttons at the top of the page as well, but I am not as sure how, or if, I should do that.

Thanks in advance for taking a look! I do think this does help to improve the docs.

corwinjoy avatar May 13 '24 23:05 corwinjoy

I did also run the linter as suggested by the contribution guide. I didn't see any errors from this addition, but it did come back pretty dirty / suggesting changes for the existing code so I'm not sure what to make of that. (Edit: Regex errors already seem to be fixed and I have fixed the reported grammar errors in a separate PR.)

corwinjoy avatar May 13 '24 23:05 corwinjoy

Hi, thanks for this PR! I passed it along to our design team for feedback. Will let you know the outcome.

szarnyasg avatar May 17 '24 09:05 szarnyasg

@szarnyasg Very cool! Does the design team have any questions or feedback? I think this would be a helpful feature for navigating the web documentation.

corwinjoy avatar Jun 01 '24 17:06 corwinjoy

Hey @szarnyasg great meeting you at the con today and it was nice to chat! I thought I might follow up on this idea since I never did hear anything back...

corwinjoy avatar Aug 16 '24 00:08 corwinjoy

Hi @corwinjoy I designed it with our designers and it's difficult – both design-wise but also logic-wise, it's not always obvious where it would lead. So we decided to postpone the implementation of this to the future. Sorry about that.

szarnyasg avatar Aug 23 '24 13:08 szarnyasg

No problem, thank you for letting me know!

On Fri, Aug 23, 2024, 6:32 AM Gabor Szarnyas @.***> wrote:

Hi @corwinjoy https://github.com/corwinjoy I designed it with our designers and it's difficult – both design-wise but also logic-wise, it's not always obvious where it would lead. So we decided to postpone the implementation of this to the future. Sorry about that.

— Reply to this email directly, view it on GitHub https://github.com/duckdb/duckdb-web/pull/2864#issuecomment-2307105228, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADBF42WOKBOX2XI6NKYS3KDZS42YDAVCNFSM6AAAAABHVB7RYGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMBXGEYDKMRSHA . You are receiving this because you were mentioned.Message ID: @.***>

corwinjoy avatar Aug 23 '24 20:08 corwinjoy