search

PolymerElements / iron-component-page

A reusable landing page for elements
36 stars 32 forks source link

README.md tab #72

Open BLamy opened 8 years ago

BLamy commented 8 years ago

(In addition to a test tab) I would really like to see yet another tab added for the README.md.

With some very small changes I think iron-component-page could actually be polymer's most powerful developer tool. Typically, in my elements readme file I put a roadmap, just a simple checklist so everyone know what the planned evolution for a particular element is.

I think these 4 tabs would really give every developer a good bang for their buck.

1) Road map Planning 2) API docs and goals 3) Demos and examples. 4) Testing

MeTaNoV commented 8 years ago

+1 /sub

MeTaNoV commented 8 years ago

(also fix linting an element through the base index.html)

notwaldorf commented 8 years ago

Right now, README.md is automatically generated from the docs inside the mail html file, which is the same thing that iron-component-page renders, so displaying it on its own wouldn't make a difference.

BLamy commented 8 years ago

@MeTaNoV I like the idea of linting but my next suggestion was going to be integrating iron-component-page directly into something like atom. (I know polymer has current issues atom's CSP). But if this where done I could be editing my file on the leftside of my editor and have a markdown preview-like window open on my right side with these 4 different views for the currently open element.

I would prefer to see that and then use the polylint plugin I already have for linting.

MeTaNoV commented 8 years ago

jup, I am still working with Sublime... I have to do a switch to Atom somehow in the near future, but I prefer concentrating my effort on finishing my set of components first! :)

blasten commented 8 years ago

@BLamy there are plans to rewrite this element to enhance its core functionalities, but I'm not sure why roadmap, planning & testing should be put in there.

BLamy commented 8 years ago

@blasten I think I went a little off topic in my OP in an attempt to provide a use case. I wasn't suggesting a tab for roadmaps & planning. I was saying we should add a tab for the markdown rendering of the readme.md file.

notwaldorf commented 8 years ago

@BLamy As I mentioned before, the readme.md file is an exact copy of the docs in the main element's html file (or, if there are multiple, an aggregation of all the elements' html files), and it's automatically generated by a bot. It doesn't contain any additional information from what iron-component-page is already displaying.

BLamy commented 8 years ago

@notwaldorf That is a part of the google's build process. It is also opinionated that iron-component-page is only used inside of google's catalogue (since it has that link to github). The majority of custom elements I work with are written by coworkers or myself where iron-component-page runs as a stand alone (And are not published on github).

We like to put important notes in the readme file, and if there was a simple tab with the markdown rendering of the readme.md file it would really enhance our productivity. I don't really think that it's all that uncommon to utilize the readme file even if google doesn't.