cssinjs/jss

Dead tradeoffs link in FAQ (Write tradeoffs.md)

Open

#1483 opened on Mar 29, 2021

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

Description

Expected behavior: Clicking "Check out [tradeoffs|https://github.com/cssinjs/jss/blob/master/docs/tradeoffs.md] for more information." opens filled tradeoffs page.

Describe the bug: Instead I get a 404.

Reproduction: Navigate to: https://cssinjs.org/faq Under item "6. Does JSS has overhead?" Click: "Check out [tradeoffs|https://github.com/cssinjs/jss/blob/master/docs/tradeoffs.md] for more information."

Related to: Issue New docs #932 "Write tradeoffs.md" from 2018.

(This issue will hopefully prevent others from having to search)

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Locate the FAQ file in the docs folder (likely docs/faq.md or similar). The broken link points to /docs/tradeoffs.md. Issue #932 from 2018 was titled 'Write tradeoffs.md' but never completed. Check if there is any existing tradeoffs content elsewhere in the repo. If not, either create a minimal tradeoffs.md based on JSS overhead discussion or update the FAQ link to a relevant section. Verify the path and ensure no other broken links.