Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Partials and properties supported #28

Closed
Satyam opened this issue Dec 4, 2012 · 10 comments
Closed

Partials and properties supported #28

Satyam opened this issue Dec 4, 2012 · 10 comments
Assignees
Labels

Comments

@Satyam
Copy link

Satyam commented Dec 4, 2012

I've just watched Apipkin's talk and learned of a couple of predefined partials, properties or whatever. From you I learned about the {{componentAssets}}. Is there a list somewhere with all of them?

BTW, I tried the {{>getting-started}} and it produces this:

<script>
// Create a new YUI instance and populate it with the required modules.
YUI().use(, function (Y) {
    // Gallery: gallery-flyweight-tree is available and ready for use. Add implementation
    // code here.
});
</script>

with the module name missing in the YUI().use(). Am I missing something? The name property is there in all the .json files where it can possibly be.

@ghost ghost assigned davglass Dec 4, 2012
@davglass
Copy link
Member

davglass commented Dec 4, 2012

Check out the Selleck docs, that is what is serving these docs under the hood: http://yui.github.com/selleck/

I'll look into the name thing, that's probably a yogi config issue

@davglass
Copy link
Member

davglass commented Dec 4, 2012

Add this to your docs/component.json file:

"use": [ "gallery-flyweight-tree" ]

@Satyam
Copy link
Author

Satyam commented Dec 4, 2012

Apipkin's example doesn't show any "use" property. It works once you know.

The selleck docs don't list any of those partials or properties. It barely mentions there can be an assets folder, but how to handle it, it doesn't say. No getting-started or much of anything else.

@davglass
Copy link
Member

davglass commented Dec 4, 2012

I just took over Selleck from @rgrove and I haven't had a chance to "beef up" the docs yet. I'll ping @evangoer to see if he can spin me some docs for it :)

@Satyam
Copy link
Author

Satyam commented Dec 4, 2012

I know, and I'm not complaining, but I had to post it for the record. Should I better post it on Selleck?

@davglass
Copy link
Member

davglass commented Dec 4, 2012

Sure, file an issue there so that I have a record of it in the project that needs docs ;)

@rgrove
Copy link

rgrove commented Dec 4, 2012

Part of the reason for this is that many of these conventions are YUI-specific, and don't belong in Selleck's generic docs. We had a page somewhere that documented many of these YUI-specific conventions, but I can't remember where that was. I think it may have been internal?

@evangoer
Copy link

evangoer commented Dec 5, 2012

Is Selleck a tool for constructing YUI user guide pages, or a generic documentation tool? If it's the former, there should be one master page describing all of the partials and properties, including YUI-specific ones. If it's the latter, then there's a case for splitting out project-specific conventions into their own list.

@rgrove
Copy link

rgrove commented Dec 5, 2012

Initially I wanted it to be the latter. Turns out I didn't care enough to make it a generic documentation tool, so it should probably just be the former.

@davglass
Copy link
Member

davglass commented Dec 5, 2012

That was my point, it's more of a YUI tool that others "can use".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants