Skip to content

Commit d784ed4

Browse files
emsimonsPseudomanifold
authored andcommitted
final edits to wiki pages
1 parent 212af71 commit d784ed4

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

content/wiki/website-maintenance/adding-tools.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ This wiki article explains how to add a new tool to the AIDOS toolbox (see [Rese
77

88
#### Important! Remember to make a branch and open a pull request! All the following changes should be made on a separate branch.
99

10-
Choose an image that represents your tool. It is best if this image is roughly square-shaped.
10+
Choose an image that represents your tool. It is ideal if this image is roughly square-shaped.
1111

1212
Save this image as `your-tool-name.svg` (.png or .jpg is also fine). Upload it to the `/static/tools/` folder.
1313

1414
### Step 2: Create a .toml file
1515

16-
In the `/data/tools` folder, add a new file named `your-tool-name.toml`.
16+
In the `/data/tools/` folder, create a new file named `your-tool-name.toml`. The toolbox cards pull from these `.toml` files when they render.
1717

1818
You can use the following as a template:
1919

@@ -54,12 +54,20 @@ In the `/content/tools.md` file, add:
5454
< tool "your-tool-name" > within a pair of double curly braces {{}}
5555
```
5656

57-
to the **top** of the list of tools. We want to preserve ordering based on most to least recently developed.
57+
to the **top** of the list of tools. (We want to preserve ordering from most to least recently developed.)
5858

59-
Sanity check: Make sure "your-tool-name" is the same as the name of your `.toml` file.
59+
**Sanity check:** Make sure "your-tool-name" is the same as the name of your `toml` file.
6060

6161
### Step 3: Final Check & PR Submission
6262

6363
After a quick check to make sure the toolbox is rendering properly with your new addition, you are ready to submit the pull request for Bastian to review.
6464

65-
Nice work!
65+
Nice work!
66+
67+
### Further Development
68+
69+
Keen to change how the tool cards render?
70+
71+
Tool cards are designed in the `/layouts/shortcodes/tool.html` file, with support from the `/layouts/partials/icons.html` file (for the GitHub and Document icons).
72+
73+
These files use classes defined in the main CSS file, found at `/themes/brevis/static/css/style.css`.

content/wiki/website-maintenance/updating-projects.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Updating projects on the homepage figure
33
---
44
As the lab engages in new projects, the website should be updated to reflect these exciting new endeavors.
55

6-
This wiki article explains how to update one of the hexagonal icons on the homepage (see [Welcome](/Welcome)).
6+
This wiki article explains how to update one of the hexagonal icons on the homepage (see [Welcome](/)).
77

88
### Step 1: Design a new hexagon overview figure using Figma
99

10-
You will need access to the AIDOS lab's shared Figma project. (Reach out to a team member if you require access). Within the project, there is a page entitled `Project Overview Figure`.
10+
You will need access to the AIDOS lab's shared Figma project. (Reach out to a team member if you require access.)
1111

12-
Here you will find the template for a new project icon, shown below.
12+
Within the project, there is a page entitled `Project Overview Figure`. Here you will find the template for a new project icon, shown below.
1313

1414
<img src="/wiki/project-template.svg" alt="Project icon template" style="width: 25%; height: auto;">
1515

@@ -25,7 +25,7 @@ For consistency, please name the file `project_title.svg`.
2525

2626
#### Important! Remember to make a branch and open a pull request! All the following changes should be made on a separate branch.
2727

28-
Upload your image (saved as `project_title.svg`) to the repo under the `/static/project-images` folder.
28+
Upload your image (saved as `project_title.svg`) to the repo under the `/static/project-images/` folder.
2929

3030
In the `/layouts/shortcodes/projects.html` file, you will see the HTML code that controls which project images are shown.
3131

@@ -42,7 +42,7 @@ Find the `project-column` div with the project you want to replace. It will look
4242

4343
Make sure you:
4444
1. Edit the arXiv link.
45-
2. Change `project-name.svg` in to the name of your new image.
45+
2. Change `project-name.svg` to the name of your new uploaded image.
4646
3. Change the alt text to reflect your project title.
4747

4848
### Step 3: Final Check & PR Submission

0 commit comments

Comments
 (0)