Skip to content
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

request: in docs of a repository, display that repository differently from its dependencies #101

Open
hrmacbeth opened this issue Dec 19, 2022 · 0 comments

Comments

@hrmacbeth
Copy link

hrmacbeth commented Dec 19, 2022

In the doc-gen for mathlib3, the left sidebar looks like this:

core
▸ data
▸ init
▸ system

mathlib
▸ algebra
▸ algebraic_geometry
▸ algebraic_topology
▸ analysis
▸ category theory
...

That is, the repo we have actually run doc-gen on (mathlib) and its dependencies (core) are displayed as headings and all of their top-level folders are displayed afterwards in a list. I like this feature because I spend a lot of time browsing mathlib and this saves me a click. Mathlib hierarchies also get pretty deep, so having all the mathlib top-level folders left-justified also saves a few indentation characters which comes in handy deeper down.

In the doc-gen for mathlib4, the left sidebar looks like this:

▸ Init
▸ Lean
▸ Mathlib
▸ Std

I can see why @hargoniX made this choice, because now the dependencies (Init, Lean and Std) all have many top-level folders, and displaying all of these would push the top-level folders from the repo of interest (Mathlib) far off-screen!

It's still annoying to have the extra click, though (and this is exacerbated by the issue in #99 causing the valid clickable region to be a single unicode symbol ).

Here is a more complicated proposal which I think would be the best of both worlds: first display the dependencies, with just their names, then display all the top-level folders of the repository of interest. So

▸ Init
▸ Lean
▸ Std


Mathlib
▸ Algebra
▸ CategoryTheory
▸ Combinatorics
▸ Control
...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant