Components: show available prebuilt themes in docs

Created on 10 Mar 2017  路  16Comments  路  Source: angular/components

Bug, feature request, or proposal:

feature request documentation

What is the expected behavior?

In the docs users should see a list of available prebuilt themes and a link to a sample page of each theme.

What is the current behavior?

No information of what themes are available and how they look like.

What are the steps to reproduce?

Providing a Plunker (or similar) is the best way to get the team to see your issue.
Plunker template: https://goo.gl/DlHd6U

What is the use-case or motivation for changing an existing behavior?

I like to use this great library but the documentation could be improved to make the start easier.

Which versions of Angular, Material, OS, browsers are affected?

Is there anything else we should know?

P3 docs help wanted

All 16 comments

@jelbourn
Issue question:
Where should these examples be created?
/src/examples/theme-NameofTheme-overview ?
Just one and then reference the other defaults, or all 4 themes?

Extra question:
Also are there going to be more default themes? / a theme builder ?

We should list all of the prebuilt themes in the theming guide.

We will add more prebuilt themes before final.

We do want to add a theme builder to the docs site eventually, but that's more of a nice-to-have.

@M-a-c Are you looking into this?

Yeah I was going to tackle it Monday if thats ok. I don't have a pr for it right now.
I think this 'show available prebuilt themes in docs' should be re-added, for when there are more themes, before going gold.

Sounds good! Thanks.

Is sample link to each theme necessary ?

If its possible can someone open a P4 on the 'theme builder' and describe how it would work? I would love to work on something like that.

I think for now we only want to list all prebuilt theme paths in the theming guide.

We could do that with a Dgeni processor or just with gulp transform.

Reading up on Dgeni and gulp now, sorry for the confusion. I had no idea this existed. I was wondering how exactly this sorta magic happened. I'll dig for an example to figure this out.

I'm not sure this is something that needs to be done with tooling; the prebuilt themes will change infrequently enough that i'm okay with just manually listing them in the guide.

@DevVersion @jelbourn I'm a bit confused with who to follow, I'm pretty sure I'm more than half way done tooling a solution. Is it ok if I continue on that?

Please do what @jelbourn proposed.

I initially thought that a dynamic solution would be appropriated but since we don't have frequent changes with the prebuilt-themes I can kind of see Jeremy's point. Sorry for the misunderstanding.

@DevVersion Thanks for the clarification.

@DevVersion can you pr my pull request #3826 its small 馃尞

@jelbourn This issue can be closed too 馃槂
Also is there a way that I can create a pr such that a merge closes the issue?

@M-a-c if your PR says "Fixes #3550" in the description it will close the issue automatically when merged.

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_This action has been performed automatically by a bot._

Was this page helpful?
0 / 5 - 0 ratings

Related issues

shlomiassaf picture shlomiassaf  路  3Comments

constantinlucian picture constantinlucian  路  3Comments

Miiekeee picture Miiekeee  路  3Comments

dzrust picture dzrust  路  3Comments

vitaly-t picture vitaly-t  路  3Comments