|
1 | | - |
2 | | - |
3 | 1 | # Tools for Learning, Design and Research |
4 | 2 |
|
5 | | -This repository is for the tldr group website |
6 | | - |
7 | | -The website can be found [here](https://tldr-group.github.io/) |
| 3 | +This repository is for the [tldr group website](https://tldr-group.github.io/) |
8 | 4 |
|
9 | 5 | ## Content Management: |
10 | 6 |
|
11 | | -This repo has been written such that to add new content (publicatons, projects, team members), only the corresponding `.json` files need to be edited, commited and merged onto main. |
| 7 | +This repo has been written such that to add new content (publications, projects, team members), only the corresponding `.json` files need to be edited, commited and merged onto main. |
12 | 8 |
|
13 | | -1. Create a new branch |
| 9 | +### 1. Create a new branch |
14 | 10 |
|
15 | 11 | ```bash |
16 | 12 | git checkout new_branch_name |
17 | 13 | ``` |
18 | 14 |
|
19 | | -2. Edit the `.json`, commit changes to your branch |
| 15 | +### 2. Edit the respective `.json`, commit changes to your branch. |
| 16 | + |
| 17 | +The `.jsons` are in the [`src/content`](src/content/) folder: |
| 18 | + |
| 19 | +- New project: `src/content/projects.json` |
| 20 | +- New paper/preprint: `src/content/publications.json` |
| 21 | +- New team member: `src/content/team.json` |
| 22 | +- New video: `src/content/videos.json` |
20 | 23 |
|
21 | | -3. Merge the branch onto `main`, either via the terminal or by creating a pull request on github.com. NB: this requires approval. |
| 24 | +When adding a new entry, **it must have all the fields (_e.g,_ "titles", "desc", ...) for that type of content** - look at other examples in the file for which fields are needed. If adding new images/gifs, these need to be placed in `public/content/images` and referenced correctly in the `.json`. |
| 25 | + |
| 26 | +### 3. Merge the branch onto `main` |
| 27 | + |
| 28 | +Do this either via the terminal or by creating a pull request on github.com. NB: this requires approval. Once merged, a GitHub Actions will trigger which will build and deploy the site. This typically takes ~10s |
22 | 29 |
|
23 | 30 | Check out `docs/` for explanations of how the website works! |
24 | 31 |
|
@@ -47,8 +54,6 @@ yarn start |
47 | 54 |
|
48 | 55 | ## TODO: |
49 | 56 |
|
50 | | -- minor fixes: better zod parsing |
51 | | - |
52 | 57 | - add Sheares! |
53 | 58 | - add new publications: llama (rsc), evoxels, vulture, image rep (adv sci), hr-dv2 (adv int sys), BIL, prompt to protocol |
54 | 59 | - add new projects: BIL, isb/isg, vulutre, evoxels |
0 commit comments