Polymer Documentation

[Luv Agarwal]

Hey,

I have been reading polymer documentation for a while now. I am wondering how does polymer generates/maintains it's documentation. By that I mean is all the documentation written as code comments, which I think is less likely the case, or some part is in the code and other is written separately. In latter case (in which some documentation is generated from code comments and other is written separately) how does it merges both? I know this question is not related to using Polymer but I was really curious about it. It would be really great if you could give the overview of how is polymer writing/maintaining it's documentation.

Thanks

Luv Agarwal

[Luv Agarwal]

I have seen the elements.polymer-project.org documentation. There I can see that each element has it's own documentation that is maintained on it's corresponding github repository. The doubt that I still have is that how are you putting all together.

[王納米]

I believe the doc of each element comes from the `seed-element`.

https://github.com/PolymerElements/seed-element

On Thu, Mar 24, 2016 at 5:40 PM Luv Agarwal <luvaga...@gmail.com> wrote:

I have seen the elements.polymer-project.org documentation. There I can see that each element has it's own documentation that is maintained on it's corresponding github repository. The doubt that I still have is that how are you putting all together.

Follow Polymer on Google+: plus.google.com/107187849809354688692
---
You received this message because you are subscribed to the Google Groups "Polymer" group.
To unsubscribe from this group and stop receiving emails from it, send an email to polymer-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/4d4ba3a3-2d5a-492f-914d-53109fa33b13%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[rictic]

For elements we write the documentation in the code and then use a bot named tedium to extract that documentation into the README.md. tedium uses hydrolysis to extract the docs from the source code, hydrolysis is also what powers our documentation pages.

polymer-project.org also has more docs, articles, guides, etc beyond what's in the source code for the elements.

[Luv Agarwal]

Thanks a lot @NanoWANG @rictic.

[Arthur Evans]

Just to add to the previous answers, if you're interested in documenting your own elements, there's some information on how to use the Polymer doc tools here:

https://www.polymer-project.org/1.0/tools/documentation.html

Most of the rest of our docs (long-form docs like guides and tutorials) are written in Markdown. Our websites (especially www.polymer-project.org) are kind of old and overdue for a refresh, so don't look too closely at how we serve those docs up :D

Cheers,

Arthur

Follow Polymer on Google+: plus.google.com/107187849809354688692

---
You received this message because you are subscribed to the Google Groups "Polymer" group.
To unsubscribe from this group and stop receiving emails from it, send an email to polymer-dev...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/62d5c881-5a72-4e96-9ab1-cb9af0ab9439%40googlegroups.com.