Reference section for docs?

[julianeden]

Hi, I'm trying out pullstate and noticed the docs are geared towards examples and how-tos but don't have any reference section listing types / methods / properties. Is there anywhere I can find that or any plan to create it? Thanks.

[julianeden]

To elaborate slightly, while working in Typescript I can see all these methods exist on the store, but I have no idea what they do and I can't easily find them in the docs without string-searching each page:

I really like the look of Pullstate but I'm a little nervous about adopting it for a large project for this reason.

[lostpebble]

Hi @julianeden ,

This is a good idea - I'll look into adding a Typedoc which is generated directly from the types and with additional information and examples where relevant.

At the same time, will see what's possible about getting some better method descriptions inline during auto-complete like that so you can quickly see what something does.

I really like the look of Pullstate but I'm a little nervous about adopting it for a large project for this reason.

I understand where you're coming from. The development up to now has been me using it for my projects and adding functionality here and there wherever I needed it (and sometimes when a user also requests something)- but there are some parts that haven't been fully fleshed out that should be removed for now, and other parts that are working that just haven't been fully documented yet.

This is a push I've been meaning to do for a while now, but regular work schedules have definitely made it difficult. I'm going to start with trying to at least get the Typedoc out this weekend.

[julianeden]

I really appreciate it and the fast response. I'm in a similar boat, working on a solo project balanced with a full time job, and I've been feeling acutely how scarce time is. No pressure! Thanks for making this.

[wnz99]

Hi,

I also find that the documentation is lacking a bit of details about the available methods. For example I had to search through issues to find this: Store.getRawState()

I'm using the library in a personal project and find it great so far. Thank you.

[lostpebble]

Hi @wnz99 ,

Yep just wanting to get all the method descriptions in and hide internal options which shouldn't be documented and clog up the Typedoc. Actually a really cool project, TypeDoc- though still finding my way around it. Work things have taken a hectic turn this week, but going to push for it in the next couple days.

Glad the library is suiting your needs :)

[lostpebble]

@julianeden @wnz99

I've created the start of the Typedoc reference for Pullstate.

There's still a lot to cover, but at least its all laid-out now. The part that's pretty much complete at the moment is for Store.

Its also a bit congested with interfaces and types, which I'll try and see how I can reduce so that its easier to get to the "meat" of the functionality when you need to.

I've hosted it here: https://lostpebble.github.io/pullstate-typedoc/

[julianeden]

First impression is great job! Looking at the Store reference in particular as recommended, it's exactly what I'd hoped for.

Agree the forest of interfaces could use some cleaning up, it makes Pullstate looks wayyy more complex and dense than it actually is. Feel like maybe most of that doesn't need to be public? Makes it harder to find what you're there for. But Idk, the important part is I have a reference for the Store! Thank you!

[julianeden]

It might be nice to add a link to this on the shiny nice docs site at https://lostpebble.github.io/pullstate/ by the way :)
Still loving pullstate, very happy I chose it for my app.

[lostpebble]

Ah I thought it was linked there already! Maybe I somehow removed it during the last doc update... Will update it again, thanks for pointing it out.

Glad to hear pullstate is still working out well for you :)