urbit / urbit.org

The source for urbit.org
https://urbit.org
MIT License
93 stars 197 forks source link

[docs] Page trees should have an index that's navigated to upon first click #713

Closed urcades closed 2 years ago

urcades commented 3 years ago

via @jalehman

It's not this way on the current site, but it should be.

urcades commented 3 years ago

The implementing team is contesting this particular issue

jalehman commented 3 years ago

That's fine, although there are many places in the docs where we put (debatably) useful information like this: https://urbit.org/docs/system-overview/

Usually it serves as an overview of the contents of each subdirectory, but I'll admit that the quality of these overviews is hit or miss. The current structure, where we have content in URLs that cannot be reached through the interface, is ambiguous and frustrating though. It'd be nice if that were solved, and this is the clearest way I can think to do it.

~wolref-podlex https://urbit.org ( https://urbit.org/ )

On Mon, Jul 19, 2021 at 12:08 PM, édouard < @.*** > wrote:

The implementing team is contesting this particular issue

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub ( https://github.com/urbit/urbit.org/issues/713#issuecomment-882789151 ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/AAEGQQUN3JZBVRXVTPFVSYDTYRZ2PANCNFSM5AUJJRNQ ).

matildepark commented 3 years ago

My main counter-example is, imagine you want to go to 2c of the standard library in Hoon.

Hoon -> refresh Reference -> refresh Standard library -> refresh 2c -> refresh

— ~haddef-sigwen https://urbit.org

On Jul 19, 2021, at 3:15 PM, Josh Lehman @.***> wrote:

That's fine, although there are many places in the docs where we put (debatably) useful information like this: https://urbit.org/docs/system-overview/

Usually it serves as an overview of the contents of each subdirectory, but I'll admit that the quality of these overviews is hit or miss. The current structure, where we have content in URLs that cannot be reached through the interface, is ambiguous and frustrating though. It'd be nice if that were solved, and this is the clearest way I can think to do it.

~wolref-podlex https://urbit.org ( https://urbit.org/ )

On Mon, Jul 19, 2021 at 12:08 PM, édouard < @.*** > wrote:

The implementing team is contesting this particular issue

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub ( https://github.com/urbit/urbit.org/issues/713#issuecomment-882789151 ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/AAEGQQUN3JZBVRXVTPFVSYDTYRZ2PANCNFSM5AUJJRNQ ).

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

g-a-v-i-n commented 3 years ago

Adding that part of the opposition to this is opening or exploring the tree navigation would navigate you away from your current page. As a reader I could not remain on my current page while opening subdirectories.

g-a-v-i-n commented 3 years ago

If we flattened the IA of the docs and constrained the depth to 2, I would be more open to this. For example

Arvo subItem subItem subItem Azimuth subItem subItem subItem ...

We could also add more depth by extending the length of each page. For example: https://nodejs.org/dist/latest-v14.x/docs/api/buffer.html

matildepark commented 2 years ago

This is now the case on urbit/developers.urbit.org, so maybe we just port it here — a possible case for packaging this entire layout into urbit/foundation-design-system ...

matildepark commented 2 years ago

Though ... on second thought, we no longer even have a nested docs layout on this site! So, it can be closed anyway.