Readme Update

[ad-ha]

@ccpk1

With the 0.3.0 release I believe that README.md needs to be revamped and updated.

Considering the README you prepared for the dashboard and all the wikis and supporting documentation, you are way better at this that I am and your docs seems better and well structured.

Without abusing of your help and willingness, do you think you could do this? If not, no worries, just let me know and I will prepare something that may adapt to it.

Cheers

[ccpk1]

I was just starting to revamp the readme for the dashboard and put together a release document. I'll take a pass at it since there's a lot of overlap. I'll plan to do a pull to the nightly build, then you can make any final adjustments. Also, for reference, here's where I started to work on mine.
https://github.com/ccpk1/kidschores-ha-dashboard/blob/KCD_0.3.4-Release/files/release_notes/kcd_0.3.4-release-notes.md

When are you thinking about releasing?

[ccpk1]

I was hoping I would have time tonight to take at least a first pass at this, but I ran out of time. I can spend some time on it in the morning.

[ad-ha]

No worries. Whenever you have the time.

We can do the release when it is all ready, if not today, tomorrow or Friday 😉

[ccpk1]

Let's try to do it later today, I should have some time in a little while to focus on it. Also, I found an issue with the state that is showing for shared chores, but I'm pretty sure I have it fixed, and that whole global processing is much simpler with this fix.

What I've realized, is that almost all the issues we've seen are related to processing chores by the "chore_state", but in reality, that is just the global_state which is not really used for any handling. Everything important is calculated per kid based on claims, approved, or overdue. Took me a long time to wrap my head around that...) 😄

[ad-ha]

Great. Let me know once you go through it.

So, can it be the reason why you were having some issues that I could not see? Not entirely, as some were needed, but the shared chores I was not being able to follow 🤣

[ccpk1]

I don't think it changed the issues I was having, but I wouldn't be surprised if it made some of my questions and comments more confusing. Take a look at the pull request I just sent for some additional updates to shared chores, I really feel like state processing is 100% now, and should be easy to tweak if we find any small issues.

[ccpk1]

I keep trying to get to this, but several other things came up today that haven't left me much time. If you want to push the release until tomorrow, I should have some time a little later to get to this, but I'm going to be offline for a few hours.

[ccpk1]

I'm not sure exactly what you were looking for in an update to the readme, but I took a pretty good attempt and enhancing it and bringing it current. As a result, I moved some of the more detailed content over to the Wiki and linked it. Feel free to move or adjust as you see fit.

Also, I did not make any references to the dashboard, but if you thought it would be helpful, you can list that as an option feature.
Essentially a way for someone to quickly get started with full access to the system capabilities. You're welcome to use images, links, etc, I'm fine either way.

Lastly, we have some really good content in the Wiki, and I've added a few more things like various tips & tricks, penalites and bonuses, etc. We probably need to come up with a little better structure at some point so things aren't hidden.

[ccpk1]

@ad-ha - One other thing I meant to do is add a link to the full wiki document for each area we have a more detailed document. i.e. in the chore achievement and challenges section, point them to the wiki document with explanation and examples. Are you OK with that idea and is it OK to commit those directly on the page, or would you prefer a pull request since it's the main page?

[ad-ha]

Hi @ccpk1

I'm fine either way, so as you prefer. In all honesty, I believe most people don't event look into the Readme anymore... They prefer to directly ask 😅😬

[ccpk1]

I made several improvements to the ReadMe formatting, added links to relevant wiki articles, and added a section at the bottom about "Making it your own". I think I'm all done on that. Looking at the release notes in just a bit.

[ad-ha]

I was able to have a look noe and it looks neat 👍

Seems great.

If you are able to go through the Release Notes, I may get it out today.

Cheers

[ccpk1]

@ad-ha - Check out the Wiki with updated sidebar.

[ad-ha]

Seems great. Thanks