uxebu / bonsai-docs Goto Github PK

How to set a color, size, family, spacing, shadow, etc. Where you can use text (is it just Text?)

Reproduce:

• go to documents on website
• zoom in on text (double tap on iphone)

result:

• content partially shown
• nav bar covers content when scrolling

possible fix:

• don't use 'position:fixed' on small screens (media queries?)

Minor issue, had to wait till I got to work to read documentation without being annoyed too much ;)

One developer bundled bonsai.js together with jquery and other components into one file. We should document, that the bonsai.js should be kept as is, so that the worker/iframe can be spawned.

Infinite recursion error!

curveBy is telling me to look at curveBy for information. Surely that ought to be curveTo :)

I know, so is the title of this issue.

For instance, check http://docs.bonsaijs.org/module-filter.filter.DropShadow.html

It starts talking about parameter, but doesn't show the finger print of the function at all.

What's it for? What's it do?

See http://docs.bonsaijs.org/overview/Text.html

The example has fillColor but that seems to be textFillColor right now.

There's a whole range of filters, but none of the gradients.

http://docs.bonsaijs.org/module-path.Arc.html

It says false where it should say antiClockwise

Once you click into a specific element’s documentation the coordinates of the x and y are clear, but it is a bit misleading from here: http://docs.bonsaijs.org/overview/SimpleShapes.html

I propose changing what is currently there to the follwing:

• new Rect(x, y, width, height, [cornerRadius]) (docs)
• new Arc(centerX, centerY, radius, startAngle, endAngle, isAntiClockwise) (docs)
• new Circle(centerX, centerY, radius) (docs)
• new Ellipse(centerX, centerY, radiusX, radiusY) (docs)
• new Polygon(centerX, centerY, radius, sides) (docs)
• new Star(centerX, centerY, radius, rays, factor) (docs)

Or even using the terse cx | cy would at least provide the additional context that it is different than the top left corner.

I see you have analytics on the bonsai marketing page, but not the docs site. Not sure if you guys care to see where the most time is spent on the docs or looking into that anymore.

http://docs.bonsaijs.org/DisplayObject.html

The type says number but should be (I believe) Point ?

Also mentions it again below on that same page. The setOrigin method should note that it's also possible to set origin directly through attr.

See filter page, link at the bottom See the filter module » points to localhost:4000. Oops!

There needs to be at least some code example that refreshes a stage by supplying new code. Something you could do from the console, for instance. Or actually something orbit is already doing.

Right now I'm simply destroying the movie and creating a whole new instance, but that can hardly be the "right" way (tm)?

Either way, please put up an example on how to refresh and manipulate the stage from "the outside".

uxebu/bonsai#156

http://docs.bonsaijs.org/

The modules, classes, and mixins navigation items no longer have children.

Also, these files are 404ing.

http://docs.bonsaijs.org/overview/lib/ace/ace-noconflict.js 404 (Not Found) PerformanceConcerns.html:7
http://docs.bonsaijs.org/overview/assets/doc.js 404 (Not Found) PerformanceConcerns.html:7

The docs don't mention morphing but I'm sure I've seen morphing demos. I think there ought to be section in or next to animation about morphing, as well as details on morphing in the api docs.

I want to use a custom font and have no clue how to include it in the app. The overview doesn't seem to mention it and the Text class does neither.

User should be able to link to headers (like methods) directly, through a hash (<a name= ... >).

See http://docs.bonsaijs.org/module-path.Path.html

The parameter list of arc, arcBy, and arcTo have most of their descriptions set to "description", which isn't helping much. The rest of the page seems okay in this regard.

Update docs once uxebu/bonsai#152 concerning uxebu/bonsai#109.

(jsdoc3 is not currently running on my system and I don’t want to look at java exceptions)

Very much missing are the event docs. Add all the events that might be registered in bonsai (keep in mind a future canvas renderer, so don't go easy and say "any DOM event", that won't suffice).

And obviously list the various ways to register or deregister events.

I've tried hooking into bonsai, stage, env, etc. I've tried sending messages with post, sendMessage, emit. None seemed to work. Please put up some examples that deal with this.

See uxebu/bonsai/issues/58

It should note that these sizes are relative to its parent (not stage or root stage or anything else).

Note that destroying is deemed to be final. Also note uxebu/bonsai#145 once it's in.

As far as I know filter.DropShadow doesn't take an array. Also we should maybe add values that make the effect visible.

Instead of
var f = new filter.DropShadow([0, 0, 0, 0x000000FF]);
we could do
var f = new filter.DropShadow(1, 1, 2, 0x000000FF);

Knowing that bonsai has a similar architecture to flash, I have come across this article: http://www.readability.com/articles/dsqhsvwg

At first I was just reading it academically to get a better understanding of matrices as a whole, but a lot of the commentary in it reminds me of what I’ve seen in the source (such as the matrix getter actually being a clone of the matrix).

Does this make sense enough to tie into the bonsai docs in any form?

In the text department, maybe mentioning clearly how to set the color of the text is nice. It certainly confused me to heck.

The menu now starts at filter.Sepia and ends with filter.BaseFilter. Should be reversed.