From a055fdfae57cb925fb50b96085285c6c28743d68 Mon Sep 17 00:00:00 2001 From: Nathan Goldbaum Date: Thu, 3 Apr 2025 08:57:46 -0600 Subject: [PATCH] fix rendering issues in mentor docs --- docs/mentors/01-index.md | 4 ++-- docs/mentors/02-prepare.md | 4 +++- requirements.txt | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/mentors/01-index.md b/docs/mentors/01-index.md index 1d97bb8..cc708a1 100644 --- a/docs/mentors/01-index.md +++ b/docs/mentors/01-index.md @@ -10,5 +10,5 @@ We have put together a set of docs to guide and help you prepare for the Mentore !!!example "Getting you ready for mentoring" For your convenience, we have created documentation for both, in-person and online sprints: - 1. **In-person**: Mentoring and preparing yourself and your project for the sprint: [preparing as a mentor](./02-prepare.md).This section provides practical advice on how to prepare and what to do to support your mentees. - 2. **Online**: we got you covered on how to [prepare youself and your project](./02-prepare-online.md), [the technical setup and platforms used](./03-online-setup.md), and a [quick tour of our Discord](./04-discord.md). +1. **In-person**: Mentoring and preparing yourself and your project for the sprint: [preparing as a mentor](./02-prepare.md).This section provides practical advice on how to prepare and what to do to support your mentees. +2. **Online**: we got you covered on how to [prepare youself and your project](./02-prepare-online.md), [the technical setup and platforms used](./03-online-setup.md), and a [quick tour of our Discord](./04-discord.md). diff --git a/docs/mentors/02-prepare.md b/docs/mentors/02-prepare.md index e78e06e..85a1497 100644 --- a/docs/mentors/02-prepare.md +++ b/docs/mentors/02-prepare.md @@ -2,7 +2,9 @@ title: Preparation --- -!!! Example "TL;DR" 1. Triage issues/tasks for the day 2. Prepare a quick pitch for your project (not needed for Git/general mentors) 3. Be prepared for an intense yet rewarding 4 hours - bring coffee/tea, and your best mentor/cheerleader/support attitude +!!! note "TL;DR" + + 1. Triage issues/tasks for the day 2. Prepare a quick pitch for your project (not needed for Git/general mentors) 3. Be prepared for an intense yet rewarding 4 hours - bring coffee/tea, and your best mentor/cheerleader/support attitude ## Before the sprints diff --git a/requirements.txt b/requirements.txt index c797df4..5ea6d22 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ cairosvg mkdocs-git-revision-date-localized-plugin -mkdocs-material>="7.1" +mkdocs-material mkdocs-minify-plugin pillow