content: Describe why certain implementations (e.g. ion-loading) are described as recommended
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start at the ion-loading documentation section linked in the issue, especially the inline-recommended guidance, and review the inline and controller examples. Document why the inline implementation is recommended, or link to a shared explanation that covers the other components with the same wording.
Written by the indexing model from the issue text.
Description
Describe Problem
For example the documentation of ion-loading describes both an inline and controller implementation, but describes the inline one as recommended without explaining why.
It would be useful to know why this is recommended at this point in the documentation as it may inform your decision about how to implement something. For example, a controller-based implementation of ion-loading may seem preferable to my use case, but if I don't know why an inline implementation is recommended it's harder to make a good choice.
Is this recommendation simply for code clarity, or does it provide a benefit to the end user?
Describe Preferred Solution
I believe there are a few components that have the same description so this could just be a link to a page describing why inline implementations are preferable.
Describe Alternatives
No response
Additional Information
https://ionicframework.com/docs/api/loading#inline-recommended
- Dominant language
- MDX
- Stars
- 621
- Forks
- 3.2k
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 86
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ionic-team/ionic-docs
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
ionic-team/ionic-docs#4705 ·
-
content package: angular
Difficulty 2/5 Half a day Newbie friendliness 78/100
ionic-team/ionic-docs#4702 ·
-
triage
Difficulty 1/5 Under an hour Newbie friendliness 80/100
ionic-team/ionic-docs#4546 ·
-
content: broken link Opencontent
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ionic-team/ionic-docs#4381 · 2 comments ·
-
triage
Difficulty 1/5 Under an hour Newbie friendliness 72/100
ionic-team/ionic-docs#3639 ·
All issues in ionic-team/ionic-docs
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docToolchain/docToolchain#1705 ·
-
kb-infra-drift
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OCHA-DAP/ds-knowledge-base#653 · 1 comment ·
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 90/100
EclipseFdn/open-vsx.org#13419 ·