Git Product home page Git Product logo

Comments (7)

Jelmerro avatar Jelmerro commented on June 7, 2024 1

Actually, I might just add it to the cheatsheet instead of changing the intro text, I'm quite happy with how that fits neatly on first run and isn't filled with all these extra features, but just the basics. People will find it if they want it, and if not they'll ask for it and I'll tell them how it works, same for any other feature I guess.

from vieb.

Jelmerro avatar Jelmerro commented on June 7, 2024

That's a good thing to consider, I'm a bit undecided on which states should be remembered or not, ideally it should all be settings, but doing that conditionally seems a bit much, so I might just add one for open/closed by default, and then remember/sync the state of the toc across pages (based on settings, so either open/closed or active/disabled) or something. What do you think is the best option here?

from vieb.

Melandel avatar Melandel commented on June 7, 2024

I would go incrementally in order to find as best as possible the sweet spot between usefulness and complexity.

For the first iteration, I personally would go without setting, ie always expand when going from hidden to shown.

Then we can learn through users' feedback whether more configurability is needed - as well as whether or not the feature is known/used

From that feedback we can infer the real use of that feature, and how far we want to go in order to make it configurable.

That's obviously just my personal opinion!

from vieb.

Jelmerro avatar Jelmerro commented on June 7, 2024

Well, that actually sounds very logical and much simpler in terms of implementation. However, I would like to have the TOC there by default on the help page, but not expanded, because it would cover a lot of the page, just shown there to let people know that it exists, but maybe that's actually not needed or too much. Now I'm reconsidering making the TOC the default for the help page, or if it should just be hidden like now and have no close toggle at all, just open=shown and closed=hidden.

from vieb.

Melandel avatar Melandel commented on June 7, 2024

I would like to have the TOC there by default on the help page, but not expanded, because it would cover a lot of the page, just shown there to let people know that it exists

I see your point.

The help page starts with a few bullet points mentionning "essential keys".

Would it be fair to have the very first bullet point be about how gc toggles the TOC?

it should just be hidden like now and have no close toggle at all, just open=shown and closed=hidden.

Come to think of it, it does make sense.

I would add that, ideally, when going from closed/hidden to opened/shown:

  1. showing the toc at the same location as last time it was shown may be interesting (in particular when the toc is so long there is a vertical scroll)
  2. tracking the currently displayed portion of the document at all times (using a color for the matching line in the toc for example) seems like a great idea. With this idea may come the idea of having a button to "display toc centered around currently displayed portion of the document")

We probably don't need to go that far in the toc features, though. I'm writing them down here mainly so I don't forget 👍

from vieb.

Jelmerro avatar Jelmerro commented on June 7, 2024

Alright I've decided to just revert the upcoming breaking change of showing the toc by default, I'll add it to the help page more clearly, but leave the tocpages as is, and start work on making it always open as the actual breaking change, for now without extra scroll features, but those are nice to haves.

from vieb.

Jelmerro avatar Jelmerro commented on June 7, 2024

Implemented in 11.0.0 🎉

from vieb.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.