Skip to content

Commit 58f3b65

Browse files
authored
docs: Special pages docs updates (#1341)
* docs: Update special-pages readme with style info * docs: Update Readme with development steps * fix: wording
1 parent ea12fab commit 58f3b65

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

special-pages/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,19 @@ This allows each respective platform to configure their integrations to use the
2424
- http://127.0.0.1:3210/build/integration/pages/duckplayer
2525
- http://127.0.0.1:3210/build/integration/pages/special-error
2626

27+
### Developing locally
28+
29+
When working in this section of the repo, one tends to be focused on a certain special-page. To keep the dev cycle quick, we serve the special-pages, then only watch files in the special-page where development is happening.
30+
31+
- `npm run serve-special-pages` run at the project root
32+
- `npm run watch -- --page=<page-directory-name>` run in `special-pages/` directory
33+
- e.g. `npm run watch -- --page=new-tab`
34+
- Follow the link from this terminal window to http://localhost:8000/ for hot loading CSS updates and more
35+
36+
### Styles
37+
38+
Instead of dark mode media queries in the CSS, we rely on `data-theme` attribute set at the App level and update properties inside rules for `[data-theme=dark]` or `[data-theme=dark] &`. This does change the specificity of properties set in this selector vs a media query.
39+
2740
### Integration Tests
2841

2942
Ensure these commands are run from the `special-pages` folder.
@@ -36,7 +49,7 @@ npm run test-int -- --project ios
3649
# to *only* run screenshot tests
3750
npm run test.screenshots
3851
# to also update screenshots (if you've made changes to anything visual)
39-
npm run test.screenshots -- --update-snapshots
52+
npm run test.screenshots -- --update-snapshots
4053
```
4154

4255
The process is as follows:

0 commit comments

Comments
 (0)