Skip to content

Commit

Permalink
final edits to wiki pages
Browse files Browse the repository at this point in the history
  • Loading branch information
emsimons authored and Pseudomanifold committed Feb 28, 2025
1 parent 212af71 commit d784ed4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
18 changes: 13 additions & 5 deletions content/wiki/website-maintenance/adding-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ This wiki article explains how to add a new tool to the AIDOS toolbox (see [Rese

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

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

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

### Step 2: Create a .toml file

In the `/data/tools` folder, add a new file named `your-tool-name.toml`.
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.

You can use the following as a template:

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

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

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

### Step 3: Final Check & PR Submission

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.

Nice work!
Nice work!

### Further Development

Keen to change how the tool cards render?

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).

These files use classes defined in the main CSS file, found at `/themes/brevis/static/css/style.css`.
10 changes: 5 additions & 5 deletions content/wiki/website-maintenance/updating-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ title: Updating projects on the homepage figure
---
As the lab engages in new projects, the website should be updated to reflect these exciting new endeavors.

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

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

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`.
You will need access to the AIDOS lab's shared Figma project. (Reach out to a team member if you require access.)

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

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

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

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

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

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

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

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

### Step 3: Final Check & PR Submission
Expand Down

0 comments on commit d784ed4

Please sign in to comment.