Style documentation is very poor

Open
#587 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start with the linked modal CSS custom properties page and reproduce the reported attempt to add opacity to the modal background. Clarify whether the page, modal host, or another element should be styled, and document a working example whose result can be verified in the modal.

Written by the indexing model from the issue text.

Description

content

URL
https://ionicframework.com/docs/api/modal#css-custom-properties

What is missing or inaccurate about the content on this page?
I mean I've been working with ionic since May in 2018 (Ionic 3 then, Ionic 4 since stable release came out) and honestly is very cumbersome to style elements. The documentation does not explain anything and what it explains it just doesn't work. most of the times I have to inspect the elements through the dev tools and see which one I'm supposed to style.

In the example I'm giving, I'm trying to add opacity to the background color of the modal but is very impossible to do. Documentation does not explain if this should be done to the page itself that the modal controller is hosting, or if there is some ion-modal element that we should tackle.

Dominant language
MDX
Stars
621
Forks
3.2k
Avg merge
1d 2h
Merged PRs (30d)
86

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ionic-team/ionic-docs

All issues in ionic-team/ionic-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.