cssinjs/jss

Simplify learning the syntax from the docs

Open

#1473 opened on Mar 21, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (7,000 stars) (434 forks)batch import
docsenhancementhelp wanted

Description

Is your feature request related to a problem? Please describe.

Currently people can't discover all syntaxes supported on a single page, because there are plugins which define syntactic extensions

Latest instance https://github.com/cssinjs/jss/issues/1472

Describe the solution you'd like

Some way to discover the entire syntax, maybe we should have a combined overview that takes all syntactic extensions into account and links to the more complete plugin docs

Are you willing to implement it? No

Contributor guide

Tech stack
javascript
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of JSS and its plugin system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the linked issue (#1472) to understand user confusion. Explore existing plugin documentation (e.g., in /packages) to list all syntax extensions. Consider creating a single overview page that aggregates syntax from all plugins, with links to detailed plugin docs. Look at JSS documentation structure for how to add such a page.