solidjs / solidjs/solid-docs

[Content]: All code examples have erros

Open
#1,184 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted planned solid
Dominant language
MDX
Stars
292
Forks
361
Avg merge
7h 51m
Merged PRs (30d)
1

Description

๐Ÿ“š Subject area/topic

/concepts/context.mdx

๐Ÿ“‹ Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/concepts/context

๐Ÿ“‹ Description of content that is out-of-date or incorrect

The code examples are inconsistent.
Most (except one or two) will not work like provided on the page.
They lack initialisation lines, are copies of the example above and therefore not working, or have other issues.

There is not one example on the page that explains or shows all the code needed to run contexts.

๐Ÿ–ฅ๏ธ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

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.

Research direction

Start with /concepts/context.mdx, linked from the Solid documentation page, and review each context code example for missing initialization, copied snippets, and other errors. Verify the examples as complete runnable demonstrations, and consider the work done when the page's examples consistently work as presented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.