search

urbit / urbit.org

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

Glossary Organization #858

Closed joshuareagan closed 3 years ago

joshuareagan commented 7 years ago

I'm going to start adding some definitions to the glossary---it's pretty short right now. But the organization seems a bit haphazard. In a way it seems like there are sections: a ship section, a Nock section, and a Hoon section---but these seem not to have much internal order. I'm sure most people use something like ctrl+f to find what they want anyway, but it still seems like we should clean this thing up.

Alphabetical order seems like the natural choice. Some things we can group together---it would be a shame to break up the Nock section, say---but otherwise alphabetical? Thoughts?

galenwp commented 7 years ago

I think alphabetical order per-section makes sense. It'd also be nice if each definition had an id so you could #link to it.

joshuareagan commented 7 years ago

Good idea.

joemfb commented 7 years ago

This time around, I am choosing to have no dog in this fight. Historical context is here: https://groups.google.com/forum/#!topic/urbit-dev/bjQ2B767yS8.

joshuareagan commented 7 years ago

The glossary is a reference document, not a tutorial, so I think alphabetizing it makes the most sense. I'm not a hug fan of the sections, though I understand why others like them. But for a glossary, the three main priorities should be (1) formal correctness, (2) completeness of coverage, and (3) it's easy to look up a term on the page. Naturally most people will use ctrl+f anyway, but it's standard practice to alphabetize as well.

xykj61 commented 7 years ago

Yeah, you're right. K, I'll merge your stuff. Thanks!