No anchor links or index for standard library

[urbit]

No anchor links or index for standard library

[philipcmonk]

Definitely agree that at least the standard library should be searchable.

It is actually possible to link to a specific section using its id, like this: http://urbit.org/~~/docs/hoon/library/4n/#-mong

It's not intuitive how to do this, so I'd argue there should be a "permalink" button or something.

[galenwp]

Yeah, it should be searchable. One experiment worth trying would be just loading everything on a single page. Then it could at least be ctrl-f-able.

Also agree that tree should have the standard 'link' next to any header. We do tag them all with ids for this purpose.

[ngzax]

This bugs me as well. I am working on a patch via an index page for this now.

[Fang-]

Will be fixed when urbit/docs#187 or something like it gets merged.

[joshuareagan]

@rmariani , let's take another look at this. Thoughts?

[rmariani]

I think searchability is a good idea. Would have to mull over what a good solution might be.

Loading everything onto a single page, though, would be overwhelming for two reasons.

1. The sheer volume of the standard library
2. Many different sections of the stdlib have identically named arms within cores. You need to know where you are for them to be useful.

[joshuareagan]

We could distinguish arms as follows: add:rs vs add:rd etc. This is just one idea though and I'm not wedded to it.

I don't want to put everything, explanations and all, on a single page, but I think having a index of links on a single page is realistic.

[joemfb]

The right answer is to have high-quality full-text search for the docs. That's a non-trivial engineering problem (especially if we do it The Right Way(tm) and implement search in Urbit). But there are 3rd-party services we could use in the mean time.

[joshuareagan]

Agreed, but to be clear, for now I'm only asking about an index for the stdlib docs.

[rmariani]

I think that https://urbit.org/docs/hoon/library/ could just such an index page. It doesn't really do anything right now.

[rmariani]

Search is happening Soon.