urbit / urbit.org

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

Ford horn rune documentation #846

Closed galenwp closed 3 years ago

galenwp commented 7 years ago

From @chc4 on June 17, 2015 18:47

Although the %ford commentary file mentions all the different horns and what they do, it's not the most discoverable place for it. The guide/a-ford.md tutorial, for example, says to check the rune index for the horn runes, but they aren't actually there yet.

Either a rune subdirectory for fas or one for %vane-specific runes should probably be created (along with updating the ford tutorial to point to it).

Copied from original issue: urbit/urbit#299

galenwp commented 7 years ago

These should definitely be in the rune index. Thanks!

galenwp commented 7 years ago

OK, now the runes are actually on track to being realized: https://github.com/urbit/docs/tree/reorg. @chc4 it would be great if you wanted to add these to https://github.com/urbit/docs/tree/reorg/docs/system/hoon/runes.

galenwp commented 7 years ago

From @chc4 on February 28, 2016 1:50

I think there were some changes to the ford runes recently to make it differ from the %ford commentary (which, incidentally, seems to have disappeared) /!mark/ and https://github.com/urbit/arvo/issues/34 are the ones I've noticed, but there might be others. Reading ford.hoon also isn't the easiest thing to understand - https://github.com/urbit/arvo/blob/master/arvo/ford.hoon#L1448 is the relevant code, but it's Greek to me. I'll write up a draft for the old ones tomorrow, though.

galenwp commented 7 years ago

Yes, I do think some of these are in flux (as per discussion here: https://github.com/urbit/examples/issues/13). @ohAitch can help understand %ford.

galenwp commented 7 years ago

We do need to have the ford runes documented somewhere. Maybe @keatondunsford can work on this at some point.

cgyarvin commented 7 years ago

This has always been a troubling organizational problem in the doc. They're not part of Hoon in the strictest, most autistic sense. But...

On Wed, Feb 8, 2017 at 12:14 PM, Galen Wolfe-Pauly <notifications@github.com

wrote:

We do need to have the ford runes documented somewhere. Maybe @keatondunsford https://github.com/keatondunsford can work on this at some point.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/urbit/docs/issues/130#issuecomment-278448049, or mute the thread https://github.com/notifications/unsubscribe-auth/AALyAe8ETTIMrA22hPpi-dpmi9RETJXMks5raiIsgaJpZM4L7Teb .

galenwp commented 7 years ago

... but we're going to document them anyway.

belisarius222 commented 7 years ago

The link earlier is no longer valid. Here are the parsers for ford runes in arvo's maintenance branch: https://github.com/urbit/arvo/blob/maint-20170614/arvo/ford.hoon?utf8=%E2%9C%93#L745

And here's master: https://github.com/urbit/arvo/blob/master/sys/vane/ford.hoon#L751

Fang- commented 6 years ago

These have been documented now. See here.