search

ianstormtaylor / slate

A completely customizable framework for building rich text editors. (Currently in beta.)
http://slatejs.org
MIT License
29.63k stars 3.23k forks source link

Slate History Documentation #3944

Open wdfinch opened 3 years ago

wdfinch commented 3 years ago

I know this isn't a true feature request in regards to changing the core library, however, I do still think that this is important.

It seems like there is very little documentation regarding the history library. I personally have struggled to find examples and understand how it works without documentation.

Being as this is a very common feature and something almost every editor would likely include, I think it would be nice to have more documentation on how to use it along with an example demoing some of the more advanced use cases.

Are there any plans to do this or would a pull request be accepted for something like this?

BrentFarese commented 3 years ago

A PR would be very welcome! We are trying to outline a 1.0 roadmap and improved documentation is on the list. Thanks!

wdfinch commented 3 years ago

Gotcha. Not sure if I understand the library well enough to write documentation, but I appreciate the response. Perhaps I could down the road when I understand it better.

BrentFarese commented 3 years ago

No worries. I am going to reopen this so we have it on our 1.0 roadmap. We will take care of it at some point. Thanks!