[new content type] Code Snippets
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
### Context
Originally in the design of the lit.dev/learn catalog we also considered a new type of content, the code snippet (or a 1 page tutorial).
This is an opportunity to share code snippets with some explanation.
Inspired by the various "X by example" documentation:
- [Go by Example](https://gobyexample.com/)
- [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
However, we also have lit.dev playgrounds. Maybe there is something light we can do there. Either better the current examples, or expand them out.
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.
Research direction
Start by reviewing the lit.dev/learn catalog and the current lit.dev playgrounds, then compare them with the linked Go by Example and Rust by Example references. Done would require a decided, implemented approach for sharing code snippets or one-page tutorials, including how they fit into the catalog or improve existing examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100