search

m4b / scroll

Scroll - making scrolling through buffers fun since 2016
MIT License
151 stars 36 forks source link

Restructuring the documentation #74

Closed dequbed closed 3 years ago

dequbed commented 4 years ago

I've recently started working with scroll and found the documentation somewhat hard to follow.

Since complaining about cool stuff I get for free (which this library definitely qualifies for) isn't all that nice I'm trying to improve the docs and structure them to be easier to follow for would-be users.

Please don't merge this PR yet; since I only just started using the library I may be wrong about some details of how stuff works; I'm mostly opening this PR to allow for easier comments and criticism on what I'm writing.

This PR will also fix #60 and fix #67 when done.

m4b commented 4 years ago

This looks great already, thanks for doing something like this! What are your plans/needs to move this from WIP -> reviewable/mergeable state?

dequbed commented 4 years ago

Sorry, I was rather slammed with ... life mostly the last days

This looks great already, thanks for doing something like this! What are your plans/needs to move this from WIP -> reviewable/mergeable state?

I'd say it's about 50% done. I want to in the end have touched up just about every file to make sure nothing is outdated and in the best case added a few examples although I think I'll do that in a seperate PR to get this one done sooner. If everything goes according to plan I'll have this one done by the end of the week ^^'

dequbed commented 3 years ago

I feel with the last commit that this is at a state where I'm happy with it to be included. The examples are not all updated yet but I would address that in a separate PR otherwise this one will not get finished for a while longer.

dequbed commented 3 years ago

Thanks for spellchecking me a few of those I should totally have catched. I made one commit for each file but if you prefer those two - or the entire PR - squashed I can do that too.

m4b commented 3 years ago

I just read through the rendered version, it is very nice, thank you so much for your patience and putting some love into the docs, incredibly appreciated :heart:

I'm going to squash all the changes if you don't mind, it's a nice holistic PR this way