Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organize for extensibility #223

Open
osher opened this issue Jul 14, 2022 · 3 comments
Open

Organize for extensibility #223

osher opened this issue Jul 14, 2022 · 3 comments

Comments

@osher
Copy link

osher commented Jul 14, 2022

I like a lot all that I read here - but -
I could not figure the logic of the order of the values in the index.

I think it's time to take a decision that will ensure the growth of this repo
Option 1 - sort values alphabetically

Pro: clear, neutral, streight forward. Con: less approachable: the narrative is lost

Option 2 - organize values in layers/chopters, each is organized internally by a narrative
Pro: able to tell the story and invite to dive deeper Con: it's prone to be disputed, and debated and could depend on personal style

I'll demonstrate:
e.g -

  • layer 1 - functional basics - pure function, arity, closure, idempotence, etc..
  • layer 2 - techniques - currying, contract, etc...
  • layer 3 - design patterns - continuation, functor, point-free, etc...

Personally I like better then 2nd option, but even I myself cannot make up my mind what comes first - techniques or design patterns, or how to divide between the two. 😛

But I do think that the basics would better come first...

I'd love to start a PR and work with you if I knew where to go with this :)

@jethrolarson
Copy link
Collaborator

I think it's come up before and we did reorder some stuff by approachability as a result but accretion and complication snuck in. We're probably due for some revision. Ultimately this is a glossary so alphabetical is the most sensical order.

One thing that's dissuaded me from choosing a prescriptive order is that I can't guess what people know coming into the page, and that really changes what they should see in what order and the definitions should stand on their own (though that's not strictly true now)

I can imagine another derivative work taking a more prosaic form as in your option 2 but that's like a whole project in itself.

@hemanth
Copy link
Owner

hemanth commented Jul 29, 2022

Wondering if we should make a gitbook out it.

@jethrolarson
Copy link
Collaborator

@hemanth Yeah. There's obviously an appetite for something like this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants