Skip to content

Commit 1ef095d

Browse files
committed
Explain assets dir in the README.md
rh-pre-commit.version: 2.0.1 rh-pre-commit.check-secrets: ENABLED
1 parent 105b515 commit 1ef095d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Diff for: README.md

+8
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ You can then run the site with this command (don't close the terminal once you'v
3838
bundle exec jekyll serve
3939
```
4040

41+
# Binary content
42+
43+
We have an ever-growing collection of binary assets, mostly images but also a few PDF slide decks etc all of these
44+
should go under `/assets/`. To try and preserve a bit of sanity to the repo we subdivide `/assets` into sections for each class of conent.
45+
- `/assets/pages/` - for binary assets related to the pages of the site.
46+
- `/assets/theme/` - for binary assets included as part of the site theme
47+
- `/assets/blog/` - for binary assets related to blog posts. Currently, blog has further sub dirs of `slides` & `images`.
48+
4149
# Excalidraw images
4250

4351
Some content such as the use-cases include diagrams drawn in Excalidraw. Browsers can't handle the format natively, so instead, in addition to

0 commit comments

Comments
 (0)