Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Outdated configuration docs #1399

Closed
Chudesnov opened this issue Mar 21, 2024 · 0 comments · Fixed by #1400
Closed

Outdated configuration docs #1399

Chudesnov opened this issue Mar 21, 2024 · 0 comments · Fixed by #1400
Labels
bug report 🦗 Issue is probably a bug, but it needs to be checked needs: complete repro 🖥️ Issue need to have complete repro provided

Comments

@Chudesnov
Copy link
Contributor

Description

#1386 changed how configuration files are named and removed certain requirements like installing @linaria/shaker as a dependency, but CONFIGURATION.md contains outdated instructions:

linaria/docs/CONFIGURATION.md

Lines 5 to 10 in 049a4cc

- `linaria.config.js` JS file exporting the object (recommended).
- `linaria` property in a `package.json` file.
- `.linariarc` file with JSON or YAML syntax.
- `.linariarc.json`, `.linariarc.yaml`, `.linariarc.yml`, or `.linariarc.js` file.
Example `linaria.config.js`:

This should either be updated to use the up-to-date names and options or removed and replaced with a link to docs at https://wyw-in-js.dev.
@Chudesnov Chudesnov added bug report 🦗 Issue is probably a bug, but it needs to be checked needs: complete repro 🖥️ Issue need to have complete repro provided needs: triage 🏷 Issue needs to be checked and prioritized labels Mar 21, 2024
@github-actions github-actions bot removed the needs: triage 🏷 Issue needs to be checked and prioritized label Mar 21, 2024
Chudesnov added a commit to Chudesnov/linaria that referenced this issue Mar 21, 2024
@Chudesnov
Update CONFIGURATION.md
7e9ec9b 
Partially resolves callstack#1399
@Chudesnov Chudesnov mentioned this issue Mar 21, 2024
Merged
Anber pushed a commit that referenced this issue Apr 25, 2024
@Chudesnov
Update CONFIGURATION.md (#1400)
546ad6d 
Partially resolves #1399
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug report 🦗 Issue is probably a bug, but it needs to be checked needs: complete repro 🖥️ Issue need to have complete repro provided
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update CONFIGURATION.md to use wyw-in-js config names Chudesnov/linaria
1 participant
@Chudesnov