parse-community / parse-community/docs

🐛 Missing examples throughout the docs

Open
#950 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:bug
Dominant language
SCSS
Stars
317
Forks
507
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
There are many cases in the docs where you see a colon where an example should follow but it's just not there.

To Reproduce
Steps to reproduce the behavior:

  1. Open the area in the docs mentioned in the screenshot.

Expected behavior
For there to be an example where the text is referring to one.

Screenshots
Screenshot_2024-05-16-08-37-08-48_40deb401b9ffe8e1df2f1cc5ba480b12

Smartphone (please complete the following information):

  • Device: oneplus 10 pro
  • OS: Android 14
  • Browser: Chrome
  • Version 124.0.6367.179

Additional context
Add any other context about the problem here.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by opening the linked screenshot and reviewing the documentation areas it identifies, then search for other passages where a colon suggests a missing example. Done means the affected references throughout the docs have appropriate examples added and the documentation renders correctly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.