search

subdgtl / Monoceros

Wave Function Collapse plug-in for Grasshopper
MIT License
63 stars 13 forks source link

Add chapter on Solver and fix minor style issues #11

Closed yanchith closed 3 years ago

yanchith commented 3 years ago

@janper Is this satisfactory or did you envision something else? Also please note the PR is draft, because there are still TODOs in there for you to renumber the table of contents and re-generate the HTML docs.

janper commented 3 years ago

could you also please explain:

  1. how the solver turns non canonical set of slots into canonical
  2. what is observation and that it is random
  3. how the change triggered by an observation propagates
yanchith commented 3 years ago

Sure I can, but 2) and 3) are vanilla WFC. If we are not counting on the reader already knowing this, then we have way more to explain throughout the entire document. If that's the case, I'd start with a chapter 0 describing vanilla WFC. I think I still do have that text lying around.

janper commented 3 years ago

i don't like leaving blank spots, so I'd go for explaining as much as we can with as simple words as possible so that even we architects can understand

yanchith commented 3 years ago

Ok, I agree, but then I would really start with a chapter called "What is Wave Function Collapse" somewhere early on. perhaps as 1.3 or 1.4 and explain WFC to the best of our ability there.

Then in the solver chapter, I'd address point 1), because that is our extension.

janper commented 3 years ago

sure. if you don't want to do it completely on your own, you can assign certain paragraphs to me

yanchith commented 3 years ago

I have already written that text last summer, we just didn't use it. Going to repurpose that.

janper commented 3 years ago

please also review of it it digestible for non programmers (check with Subdigital?). the new text is on the verge of it

yanchith commented 3 years ago

The text was already reviewed by at least @kr1sta2 and you :) I'll ask her to go through it again and post it on our internal channels.

yanchith commented 3 years ago

The last commit reuses some of my old text to explain vanilla WFC. I am still going to explain point 1) you mentioned above in the solver chapter.

yanchith commented 3 years ago

@janper If you are happy, I am happy. Merge when ready. You might also want to generate the HTML docs (not sure how you do that) so they are in sync.