Create - Examples and notes for STATE

[ddroid]

@todo

#30

• create examples
  • @input 📦 from alyhxn's playproject
  • @output ❓from Examples

---

• Refine Example - 3
  • @input 📦 from Examples 3,4,5
  • @input 📦 from Discord Feedback
  • @output ❓from Example3

---

• Create Doc for new developer
  • @input 📦 from Alyhxn's video
  • @input 📦 from Doc Folder
  • @input 📦 from Discord State Thread
  • @output ❓from newbie-guide.md

---

• Update exampled example 3
  • @input 📦 from Example 3v1
  • @output 📦 from Example 3v2

[ddroid]

Tasks

• Example 3:

  - Purpose: For State.js Testing and understanding
  • Created first btn.js - 1hr20min
  • Created first app.js - 50min
  • Discussions on Discord about error - 1hr30min
  • Got at call with alyhxn- 30min
  • Fixed error and created text.js - 1hr40min

---

• Example 4 & 5:

  - Purpose : to get feedback about the correct way of using fb_module and linking subs.
  • Created example 4 by modifying example3 - 50 min
  • Created example 5 by modifying example3 - 40 min
  • Discusson about fb_mod, fb_ins, sdb, watch(), onbatch(), subs and Sid's - 1hr30min
  • Recorded youtube video explaining examples - 20min
  • Created issue and recorded worklog - 30 min
    • @output 📦 Webpage
    • @output 📦 Video
    • @output 📦 Examples 3,4,5

Worklog

• worklog-07

Feedback

• This worklog is for the work I did from 16 feb to 24 feb, till this message from discord chat - Message Link Discord

[ddroid]

Tasks

• Refine Example 3:

  • Discussions Discord - 1hr20min
  • Refining & Experimentation - 3hr
  • Finding bugs - 1hr30min
  • Got at call with alyhxn- 20min
  • Recorded worklog & created issue - 20min
    • @output 📦 Webpage
    • @output 📦 Example3

Worklog

• worklog-08

[serapath]

feedback 2025.02.27

Hey, just checked the changed files in your pull request and noticed you touched STATE.js and localdb.js as well. That is great, but it screams for merge conflicts.

Those kind of changes have to be merged quickly and/or coordinated with ali, so that he does not change the same files and applies changes so complex that it becomes too much work to fix an outdated pull request.

So lets coordinate with ali quickly to get the bug fixes or whatever merged.
And that override1,2,3 dont work the same as override0 is definitely a bug and needs to get fixed as well :-) Great that you discovered it - i assume there are more bugs we'll find soon.

If you think it is easy enough for you to fix, you can offer pull requests for that as well, but the STATE module code is quite involved, so maybe ali is more familiar and can fix it faster.

---

Regarding an override for the module fallback of button, e.g. btn: { $: ([btn]) => btn() }
This is NOT supposed to change the default drive data for any buttons, BUT, if you set the api property and give it a different api function, then YES, that is being used as the new "default" for every instance that will get made, so you could change the default name "Button" to be e.g. "click me", but still every button instance would have the same text if you dont define overrides for individual instances.

So that kind of override makes more sense for changes that you dont plan to change on every instance, e.g. maybe if you want to define a default styling for every button instance that fits your app better than what the button itself defines :-) ...if that makes sense.

Again - just calling ([btn]) => btn() is not making any changes, but just replaces the default with the data provided by the default ...essentially not changing anything. You would need to of course return something changed then just what btn() returns ... if that makes sense as well :P

If that doesnt work - then congratulations, you found another BUG :-)
Feel free to open an issue STATE MODULE BUGS :P ...and create a todo list for ali, listing all the bugs and providing some explanation or screenshots. ...or if you think its easy to fix, make a pull request for ali to merge and create a worklog for that :-)

...just coordinate with ali, to avoid merge conflicts as much as possible.

So for example the above is NOT gonna change the button text.
Why?
Because the module itself has a drive too, which is independent of button instance drives.
But, the data = btn() has more than just a data.drive attribute. It has a data.api attribute as well and THAT is the function which defines default data for button instances, so if you override it, it should give you a changed default for button instances.

Maybe try that and create a task for ali if it doesnt work, because that would be a bug.

---

There is more problems and bugs.

Now the above in theory should be defined like the following:

data.drive = {
  'lang/' {
    'en-us.json': JSON.stringify({
      label: 'Button 3'
    }
  }
}

At the moment we dont stick to the rules that:

1. all folder names should end with a "/"
2. all filenames should have an extension, like .json or whatever else we have
3. all values should be primitive values or ArrayBuffers, but not arrays or objects.

The reason is, we want to be able to actually persist this on disk and load it over the network. If we create arrays or objects, like { raw: { label: 'Button 3' } } instead of JSON.stringify({ raw: { label: 'Button 3' } }), then we cant e.g. make a fetch(url) call to grab those files later on or at least it would require some processing behind the scenes which we try to avoid.

[ddroid]

Tasks

• Create Guide for New Developers:

  • Discussions Discord and reading feedback on alyhxn's worklogs - 8hr30min
  • Reading Docs usage.md,state.md and state-usage.md - 1hr30min
  • Understanding Example1 and watched alyhxn's video - 2hr30min
  • Wrote newbie-guide.md - 4hr20min
  • Recorded worklog & created issue - 20min
    • @output 📦 newbie-guide.md

Worklog

• worklog-09

Feedback

• This worklog is for the workdone from 1 feb to 15 feb and also 27, 28 feb

[serapath]

feedback 2025.03.01

Hmm, so the newbie guide is not wrong. I personallyimagine it wouldnt help too much, because if you know how the state module works, everything seems correct, but if you dont know it yet i imagine WITHOUT seeing examples and code snippets explained with comments, but still - the code snippets being the main thing, it wouldnt help a lot, but we will have to see what the next dev thinks in terms of helpfulness.

Ali already wrote a more abstract code snippet and explanation so i was more hoping for examples with comments and lots of comments to explain them or at least link to code snippets of the example1 or example2 or example3 files.

Anyway. Lets leave it for now. I think it is good enough. We dont have to refine it further.
Ali will probably also add some updates and as long as we (me, ali, and you) understand everything, lets focus on building the ui-components using it.

Basically, while it isnt bad, it was a bit shocking to see how long things took (e.g. 8h discussion, 4 hours writing it ...i imagine dumping some information and code into chatgpt would already generate something decent and it would take way less. taking actually multiple hours for it is maybe worth it, but then i expected maybe even diagrams and really sophisticated documentation).

But I also see that you say its 1st, 15th and 27/28 of february, so it probably just summing up a lot of time spent over time and this is the main reason we want to be strict with worklog should ALWAYS be published the same day the work happened.

Thus, if you plan to work 20 minutes on a day, work 15 minutes and take 5 minutes for the worklog. If you plan to work 3 hours, work 2.5 hours or 2 hours and 50 minutes and take 10 minutes or more for the worklog.

If you work 5 or 6 hours, again ... stop early and use the last 15 minutes to produce and upload the worklog.

Because i am sure you did a lot of other things that are important and that took this time, but because it has been some time, its hard to remember everything in detail and then it reads weird.

So please, lets try to stick to ALWAYS end a work session (no matter how long) with publishing the worklog video.

[ddroid]

Tasks

• Updated old code - 1hr
• Disscussion - 1hr40 min
• Finding errors and reproducing them and fixed the mistake - 1hr30min
• Created issue and recorded worklog - 20 min
  • @output 📦 Webpage
  • @output 📦 Examples 3

Worklog

• worklog-18