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

Document standard icons and glyphs #302

Closed
lucaswoj opened this issue Mar 22, 2016 · 8 comments
Closed

Document standard icons and glyphs #302

lucaswoj opened this issue Mar 22, 2016 · 8 comments

Comments

@lucaswoj
Copy link

In #241 we added standard icons and glyphs to all our styles 🎉

This standard set should be documented somewhere. This repo's README.md would be good or there might be a better place.

ref http://stackoverflow.com/questions/36131298/mapbox-gl-js-available-icons

@amyleew
Copy link
Contributor

amyleew commented Mar 22, 2016

README.md update with #304 merge.

@amyleew amyleew closed this as completed Mar 22, 2016
@lucaswoj
Copy link
Author

I'm getting feedback from our users that we need to make the standard icon set easier to navigate. Creating a reference that shows all icons and their names in one place would be a good step.

@samanpwbb
Copy link
Contributor

Are
https://github.com/mapbox/maki/blob/master/layouts/streets.json or https://www.mapbox.com/maki-icons/#editor (click new, select streets set) helpful?

Ideally we maintain this data in one place. The layout/streets file can be required via npm.

@lucaswoj
Copy link
Author

Are
https://github.com/mapbox/maki/blob/master/layouts/streets.json or https://www.mapbox.com/maki-icons/#editor (click new, select streets set) helpful?

Both are helpful, neither is quite what our users are looking for. Imagine yourself as a Mapbox user. You'd want to see:

  • all icons in one place
  • the name of each icon as it should be used in the style

https://github.com/mapbox/maki/blob/master/layouts/streets.json doesn't show what the icons look like

https://www.mapbox.com/maki-icons/#editor requires some interactions before the icons are visible, doesn't show icon names except on hover, and doesn't show icon names as used in styles (these have a .svg suffix)

Ideally we maintain this data in one place. The layout/streets file can be required via npm.

Agree.

@samanpwbb
Copy link
Contributor

I recommend that we add a section to the default style pages (https://www.mapbox.com/studio/styles/mapbox/streets-v9/share/) that lists all icons in a way that is convenient for developers.

@lucaswoj
Copy link
Author

I am uncomfortable putting a login page between users and documentation for open source software.

A markdown table within the mapbox-gl-styles README.md documentation would go a long way towards making our default sprites easy to nagivate.

@samanpwbb
Copy link
Contributor

We can create a new page for default icon documentation and link to it from wherever necessary so the page is open.

@lucaswoj
Copy link
Author

Closed by #318

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

3 participants