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

Better API reference and more docs #91

Open
falconair opened this issue Jun 20, 2014 · 6 comments
Open

Better API reference and more docs #91

falconair opened this issue Jun 20, 2014 · 6 comments

Comments

@falconair
Copy link

Perhaps the audience for this library is someone with deep knowledge of the DOM. For casual web developers, like myself (I'm a serverside guy), the documentation is a bit lacking.

For example, what is exactly the difference between lifecycles inserted and created? What is the attributes dictionary under accessors. My current problem, what is the best way to deal with nested tags. For example, If I have <x-chart width ...height ...>. First, where will I be able to access the width, height AND column fields, so I can generate the chart. How do I access axis attributes inside chart register function?

@csuwildcat
Copy link
Member

We are working on this right now, I have made progress adding docs to our new ReadMe.io hub here: http://x-tag.readme.io/v1.0/docs

@cvan
Copy link
Contributor

cvan commented Nov 18, 2015

https://x-tag.github.io/ just launched today with decent docs

@otter-computer
Copy link

Some workflow docs and tools would be appreciated too

@csuwildcat
Copy link
Member

I am working on adding further docs and details on our packaging tool choices.

@oskarrough
Copy link

Is the readme.io link still relevant? Otherwise it might be a good idea to cut one so there's just one version of the documentation 👍

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

No branches or pull requests

5 participants