Comments (11)
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.
from urbit.org.
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.
from urbit.org.
This bugs me as well. I am working on a patch via an index page for this now.
from urbit.org.
Will be fixed when urbit/docs#187 or something like it gets merged.
from urbit.org.
@rmariani , let's take another look at this. Thoughts?
from urbit.org.
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.
- The sheer volume of the standard library
- Many different sections of the stdlib have identically named arms within cores. You need to know where you are for them to be useful.
from urbit.org.
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.
from urbit.org.
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.
from urbit.org.
Agreed, but to be clear, for now I'm only asking about an index for the stdlib docs.
from urbit.org.
I think that https://urbit.org/docs/hoon/library/ could just such an index page. It doesn't really do anything right now.
from urbit.org.
Search is happening Soon.
from urbit.org.
Related Issues (20)
- Getting started curl links don't work HOT 4
- Add dock and runtime binary instructions to CLI getting started guide
- For docked binaries setcap needs to be run on .run not ./urbit HOT 3
- developers.urbit.org/blog doesn't have an RSS feed HOT 1
- Explain somewhere why Urbit uses new names for everything HOT 2
- ecosystem: groups application has references the wrong distribution source HOT 1
- ecosystem: add talk HOT 1
- ecosystem: add image/text content to groups app
- ecosystem: remove Group Discovery group HOT 2
- Can't link to sections of Getting Started HOT 1
- "Command-line install" instructions transform vere binary into urbit HOT 1
- Search doesn't pick up <h3> content
- dojo filesystem tools are hard to use when they don't exist HOT 1
- insufficient search results
- Groups listed in directory out of date? HOT 2
- manual/running/hosting page causes confusion about ames ports
- Header shows up in ToC even when used solely stylistically
- roadmap should be listed in the navbar
- Latest runtime download links missing HOT 1
- Correct %chum/%near docs
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from urbit.org.