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

OWD project: Revamp MDN CSS color documentation #92

Closed
teoli2003 opened this issue Mar 23, 2022 · 6 comments
Closed

OWD project: Revamp MDN CSS color documentation #92

teoli2003 opened this issue Mar 23, 2022 · 6 comments
Assignees

Comments

@teoli2003
Copy link
Member

Summary

Update our pretty old documentation about CSS colors by rewriting <color> and writing a few guides and glossary entries to describe modern concepts like gamut and color schemes.

Background

Our documentation about CSS color is pretty old. Its structure dates from a time when keywords and rgb() were the only possible CSS Colors.

Nowadays, numerous new color schemes have been added, and are listed on the page but without overall explanations. CSS Color Level 5 is adding two more functions color-mix() and color-contrast() that are documented but not linked from <color>. They are implemented behind flags by two browsers and CSS Color Level 5 is part of INTEROP 2022.

New concepts in the world of web development (like gamut and color schemes) are not explained on MDN but only linked to Wikipedia where the explanation is larger than the one needed in web development.

Prioritization criteria

  • Effort
    • Small to medium. This is the update/creation of 5 to 10 pages, with some research.
  • Dependencies
    • None.
  • Community enablement
    • Not really.
  • Momentum
    • This will support INTEROP 2022.
  • Enabling learners
    • Currently the <color> documentation is complex this will help untangle basic and advanced concepts, as well as having a guide and explanation for the advanced ones.
  • Enabling professionals
    • Significant. This is a new development of the web.
  • Underrepresented topics / ethical web
    • Not applicable.
  • Operational necessities
    • None.
  • Addressing needs of the Web industry
    • INTEROP 2022.
@teoli2003
Copy link
Member Author

teoli2003 commented Apr 4, 2022

As a first part, I'm simplifying the <color> page.

This page is extremely long, with long tables and lists. The idea is to move these extensive details to their specific pages. This will lead to the necessity to update the structure of BCD for <color> so that each subpage can have its own spec/bc sections (They are very long now!).

Once this is done, and still on <color>, I can simplify the summary entries for each function (rgb(), lab(), …) in this main page so that they are shorter and don't duplicate the content of the subpage.

The idea is to have the <color> page useful for beginners (to have an overview of the possible syntaxes) and for experts who want to find quickly if they have to use hwb() or lab(), or to remember a syntax they are unsure of.

@Elchi3
Copy link
Member

Elchi3 commented Sep 5, 2022

@teoli2003 can you post an update what got done here and what is the still left to do?

@Elchi3 Elchi3 changed the title OWD Project Proposal: Revamp our CSS color documentation OWD project: Revamp our CSS color documentation Sep 7, 2022
@Elchi3 Elchi3 changed the title OWD project: Revamp our CSS color documentation OWD project: Revamp MDN CSS color documentation Sep 7, 2022
@Elchi3
Copy link
Member

Elchi3 commented Sep 15, 2022

Question from the planning call: Are color fonts part of this?
COLRv1 font format, cf. mdn/content#20106

Assigning this to @teoli2003 to prepare a task list for what we still want to do here in q4.

@teoli2003
Copy link
Member Author

Question from the planning call: Are color fonts part of this? COLRv1 font format, cf. mdn/content#20106

It isn't. This project is dealing with what color feature that relates to INTEROP2022.

@Elchi3 Elchi3 added q4 2022 and removed proposal (actionable) Enough information is provided and the work is scoped well. Actionable but not prioritized right now labels Oct 20, 2022
@Elchi3
Copy link
Member

Elchi3 commented Dec 15, 2022

@teoli2003 can you summarize the status of this project as of Q4 2022? Thank you!

@Elchi3
Copy link
Member

Elchi3 commented Jan 31, 2023

Closing this. Color docs have been improved as part of the documentation work we did for interop 2022. We can create a new project about Color docs if needed.

@Elchi3 Elchi3 closed this as completed Jan 31, 2023
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

4 participants