Skip to content

Commit 58cbfcb

Browse files
committed
fix: Correct spacing, font size, and spelling issues in slides/deco/weekthree/index.qmd.
1 parent 99cfdd9 commit 58cbfcb

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

slides/deco/weekthree/index.qmd

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Understanding README-Driven Documentation"
33
description: "Use READMEs for documentation"
44
date: "2025-09-17"
55
date-format: long
6-
author: Chezka Quinola, Brandon Thompson, DJ Battle, Jordi Tort, Gregory M. Kapfhammer
6+
author: Chezka Quinola, Brandon Thompson, DJ Battle, Jordi Tort
77
execute:
88
echo: true
99
format:
@@ -63,8 +63,8 @@ format:
6363

6464
<!--DJ-->
6565
## Why It’s Helpful
66-
- It forces you to write documation before coding
67-
- You can see what evryone is doing without having to explain the code
66+
- It forces you to write documentation before coding
67+
- You can see what everyone is doing without having to explain the code
6868
- Lays out the guidelines for each member of the team to follow easily
6969

7070
---
@@ -79,19 +79,24 @@ format:
7979

8080
<!--brandon-->
8181
## Best Tips
82+
83+
::: {.incremental style="font-size: 0.9em;"}
84+
8285
- Keep new users in mind
8386
- Make sure your `README` is structured to be not only accessible but also understandable for new users
8487
- Clearly outline your project
8588
- Make sure that your `README` explains the project that you're doing and also why you are doing it, as well as the problem it solves and what makes it stand out.
8689
- Define key features
8790
- On top of outlining the project and why you're doing it make sure to include the project's key features
8891

92+
:::
93+
8994
---
9095

9196
<!--brandon-->
9297
## Wrap-Up
9398
- README is your project’s front door
94-
- README introduces your project in a way thats easy to understand
99+
- README introduces your project in a way that is easy to understand
95100
- It helps your team stay organized and on task, as well as helping to avoid problems
96101
- Clear docs = happy users
97102
- README clearly outlines your project reducing confusion for users

0 commit comments

Comments
 (0)