Skip to content

Commit bcf19cc

Browse files
Fix typos and improve clarity in various documentation files across the project
1 parent 23c90bd commit bcf19cc

File tree

13 files changed

+36
-36
lines changed

13 files changed

+36
-36
lines changed

docs/about/0xfab1/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
## MkDocs
66

7-
To honor [this post](https://rakhim.org/images/honestly-undefined/blogging.jpg) (and ensure the message remains true) I will use my own website as an example and show how I configured the static web app and make it to work the way it does.
7+
To honor [this post](https://rakhim.org/images/honestly-undefined/blogging.jpg) (and ensure the message remains true) I will use my own website as an example and show how I configured the static web app and make it work the way it does.
88

9-
I am using [Github Pages](https://pages.github.com/) to host the content, [Mkdocs](https://www.mkdocs.org/) to create the website from markdown files as input and have own [domain](https://0xfab1.net/) for a nicer URL.
9+
I am using [Github Pages](https://pages.github.com/) to host the content, [Mkdocs](https://www.mkdocs.org/) to create the website from markdown files as input and have my own [domain](https://0xfab1.net/) for a nicer URL.
1010

1111
[MkDocs](https://github.com/MkDocs/MkDocs/) is a great way to host a simple, static website. This website uses [Material for MkDocs](https://github.com/squidfunk/MkDocs-material) which is a theme for MkDocs.
1212

13-
To quickly create and host a static website (or rebuild this website), you have two choices:
13+
To quickly create and host a static website (or rebuild this website), you have two options:
1414

1515
- Docker
1616
- Python
@@ -23,7 +23,7 @@ cd FullByte.github.io # Go to main folder
2323
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/MkDocs-material # run the container
2424
```
2525

26-
Old docker file
26+
Old Dockerfile
2727

2828
``` dockerfile
2929
FROM python:3
@@ -38,7 +38,7 @@ ENTRYPOINT ["mkdocs"]
3838
CMD ["serve", "-a", "0.0.0.0:8000"]
3939
```
4040

41-
Current dockerfile
41+
Current Dockerfile
4242

4343
``` dockerfile
4444
FROM python:3-slim AS builder

docs/about/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
This is a personal blog, so the content is about me and things I am interested in.
44

5-
- About [me](me/index.md) deals with things about me.
6-
- About [life](life/index.md) contains ultimate wisdom about life.
5+
- About [me](me/index.md) covers personal topics.
6+
- About [life](life/index.md) contains thoughts and insights about life.
77
- About [0xfab1](0xfab1/index.md) contains details about this website.

docs/about/life/digital.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Don't limit yourself in undesired ways but rather optimize how to consume information.
66

77
- Mute sounds that annoy and distract.
8-
- Block users, unsubscribe oder block mails - whatever is undesired should not reach your attention more than once.
8+
- Block users, unsubscribe or block mails - whatever is undesired should not reach your attention more than once.
99
- Disable popups and redirect/move messages that are just informational.
1010
- Limit the number of services you use and actually use them.
1111
- Be active, not passive: Don't behave based on triggers like notifications, sounds, new mails. Read whenever you make yourself time for it. (This works for work as well)
@@ -17,9 +17,9 @@ The principle of valuing files above applications underscores the importance of
1717

1818
To guarantee that your documents remain legible for generations to come, even on computers from the years 2050 or 2525, they should also be understandable on a system from the 1960s. The lasting impact of your digital work depends more on the files themselves than on the software tools with which they were made. While applications might become obsolete, files have the potential to persist. Consider the ancient hieroglyphs in the Egyptian pyramids - the messages they convey are more significant than the instruments used to etch them.
1919

20-
This principal can be extended to:
20+
This principle can be extended to:
2121

22-
- Don't be dependant on services that you can avoid.
22+
- Don't be dependent on services that you can avoid.
2323
- If you use services understand how you can migrate to the next service before using it.
2424
- Prefer offline working tools if possible and feasible.
2525
- Keep it as simple and stupid as possible without limiting yourself on functions you need.

docs/about/life/finances.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Finances
22

3-
Aside from spending or investing money, doing things without involving money can be very satisfying too... but this is page is not about that.
3+
Aside from spending or investing money, doing things without involving money can be very satisfying too... but this page is not about that.
44

55
## Spend
66

@@ -13,18 +13,18 @@ Good things to spend money on:
1313
- Health (sports, sport equipment, healthy food)
1414
- Hobbies and fun stuff (games, holidays, events)
1515
- Education (learn things and have a good time, not college, just fund your experiments. (Education can be an investment, but not under my definition above and I suggest to not look at it that way)
16-
- Things that make you feel good (a picture on the wall, nice cloths, replace that thing that bothered you)
16+
- Things that make you feel good (a picture on the wall, nice clothes, replace that thing that bothered you)
1717

1818
### What to buy
1919

2020
Obviously it is not a good idea to buy things you don't need with money you don't have to impress people that don't care.
2121
Rather buy things that spark joy and you are willing to actually use and make you happy/life better.
2222
Get rid of those things that don't.
23-
Know when to gift friends, sell, through away or store it for later.
23+
Know when to gift to friends, sell, throw away or store it for later.
2424

2525
Remember that you always pay twice for every purchase:
2626

27-
- First you pay money have it
27+
- First you pay money to have it
2828
- Then you pay time to use it
2929

3030
Don't pay the first price if you won't pay the second price.

docs/about/life/fun.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ This process diagram visualizes the steps involved:
2727

2828
## Protest
2929

30-
It is not easy to protest in a smart and effective way. In my opinion strikes, demonstrations, letter-writing campaigns, petitions, sit-ins and occupation are not very effective nor creative. Of course on can passively boycott whatever thing to not support and tell friends about what and why not to support but this is boring and small minded as well. Here are some examples and ideas how to protest on a given matter in an interesting, not annoying and creative way while being effective and successful:
30+
It is not easy to protest in a smart and effective way. In my opinion strikes, demonstrations, letter-writing campaigns, petitions, sit-ins and occupation are not very effective nor creative. Of course one can passively boycott whatever thing to not support and tell friends about what and why not to support but this is boring and small minded as well. Here are some examples and ideas how to protest on a given matter in an interesting, not annoying and creative way while being effective and successful:
3131

3232
- [Ugly Gerry](https://fontsarena.com/ugly-gerry/) is a [free font](_gerry.otf.zip) created with real US congressional districts. The name comes from gerrymandering, the process that made possible such weird shapes.
3333

3434
- [Volkswagen](https://github.com/auchenberg/volkswagen) can be integrated in your CI process. It detects when your tests are being run in a CI server, and makes them pass. Volkswagen uses a defeat device to detect when it's being tested in a CI server and will automatically reduce errors to an acceptable level for the tests to pass. This will allow you to spend less time worrying about testing and more time enjoying the good life as a trustful software developer.
3535

36-
- The creative ways the [DeCSS](https://en.wikipedia.org/wiki/DeCSS) crack was distribted (e.g. [t-shirt](_decss_tshirt.jpg), [haiku](_decss-haiku.txt) or [midi](_decss-auth.mid), [audio](_decss_descramble.mp3), [html dvd logo](_decss-dvdlogo.html.txt) and [many more](https://www.cs.cmu.edu/~dst/DeCSS/Gallery/)...). Later works by "removing all the white space, then transforming each ASCII character into a single 32nd note of its midi equivalent (midi notes, like ASCII characters, are coded into values ranging from 1 to 127.)".
36+
- The creative ways the [DeCSS](https://en.wikipedia.org/wiki/DeCSS) crack was distributed (e.g. [t-shirt](_decss_tshirt.jpg), [haiku](_decss-haiku.txt) or [midi](_decss-auth.mid), [audio](_decss_descramble.mp3), [html dvd logo](_decss-dvdlogo.html.txt) and [many more](https://www.cs.cmu.edu/~dst/DeCSS/Gallery/)...). Later works by "removing all the white space, then transforming each ASCII character into a single 32nd note of its midi equivalent (midi notes, like ASCII characters, are coded into values ranging from 1 to 127.)".
3737

38-
- Address your issues to the correct people. If you work in an social or public based service make sure to create awareness but don't let uninvolved suffer from your problems. For example if drive a bus, let passengers ride for free and let them know you are protesting instead of not driving and letting people down.
38+
- Address your issues to the correct people. If you work in a social or public based service make sure to create awareness but don't let uninvolved suffer from your problems. For example if you drive a bus, let passengers ride for free and let them know you are protesting instead of not driving and letting people down.
3939

40-
- Make art (music, pictures, games) that help people understand the problem. Make things that are understandable as well as entertaining, interesting, provocative and/or beautiful. This will address the problem in an entertaining but critical way that is no annoying an will be much more likely be shared, discussed and addressed.
40+
- Make art (music, pictures, games) that help people understand the problem. Make things that are understandable as well as entertaining, interesting, provocative and/or beautiful. This will address the problem in an entertaining but critical way that is not annoying and will be much more likely be shared, discussed and addressed.
4141

42-
- Find ways to educate the public about the core issue of your protest any what needs to be done. Reflect on your issue and make sure this is not just an opinion but actual facts that can be educated.
42+
- Find ways to educate the public about the core issue of your protest and what needs to be done. Reflect on your issue and make sure this is not just an opinion but actual facts that can be educated.
4343

4444
- Never interrupt your enemy when he/she is making a mistake.

docs/about/life/health.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Be patient and consistent when forming a new habit: start small, track your prog
113113

114114
### Getting Rid of Bad Habits
115115

116-
To effectively break bad habits identify triggers and replace them with positive behaviors and reward yourself.
116+
To effectively break bad habits, identify triggers and replace them with positive behaviors and reward yourself.
117117

118118
- **Identify Triggers**: Recognize what triggers your bad habit. It could be stress, boredom, or specific situations.
119119
- **Replace with Positive Behavior**: Substitute the bad habit with a positive one. For example, if you bite your nails when stressed, try squeezing a stress ball instead.

docs/about/life/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a collection of hand picked wisdom accumulated for the worthy. Hopefully
77
Let's start with some random quotes:
88

99
- A society grows great when old men plant trees in whose shade they shall never sit.
10-
- Its okay to go through awful places, just don't stop and unpack.
10+
- It's okay to go through awful places, just don't stop and unpack.
1111
- If you choose not to find joy in the snow, you will have less joy in your life, but the same amount of snow.
1212

1313
## Topics
@@ -21,12 +21,12 @@ All topics in this "life" section deal with wealth and prosperity. Wealth can be
2121
- [Digital lifestyle](digital.md)
2222
- [Social Wealth](social.md)
2323

24-
Some topics i will eventually cover later:
24+
Some topics I will eventually cover later:
2525

2626
- Ideas (Intellectual Wealth)
2727
- Heritage (Cultural Wealth)
28-
- Freedom - (sTime Wealth)
28+
- Freedom (Time Wealth)
2929
- Fulfillment (Spiritual Wealth)
30-
- Joy - (Emotional Wealth)
30+
- Joy (Emotional Wealth)
3131

3232
I also collected and formulated some not so serious advice in the [fun](fun.md) chapter.

docs/about/life/projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
What ever you do, what ever you want to achieve, approach it as a project.
44

55
Most of the time, the project you are doing either mainly needs to be done by a due-date or done according to specs/requirements.
6-
Figure out what project you are working on (what is the main fokus?).
6+
Figure out what project you are working on (what is the main focus?).
77
Choose two of the three constraints shown below and choose the best framework that seems to fit best:
88

99
![projects_overview](_projects_overview.drawio.svg)

docs/about/life/social.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If they want advice but it doesn't work, here are some possible reasons to refle
2929
7. Meide die Nachrichten (Mainstream Media, Personenbezogene Nachrichten und sensationsgeile Quellen)
3030
8. Prügele Dich nicht mit Nazis (sei Schlau im Konter geben und demonstrieren)
3131
9. Oute Dich (XXXXXX)
32-
10. Sei realitisch (sei kein träumer und kein pessimist)
32+
10. Sei realistisch (sei kein Träumer und kein Pessimist)
3333

3434
### More Rules
3535

@@ -38,4 +38,4 @@ More good advice I collected from random places over time:
3838
Showing sometimes is 50%:
3939

4040
- Quote: "Show up is better than not showing up" or "Anything worth doing is also worth doing half assed".
41-
- Example: brushing ur teeth for 10 seconds is better than 0 seconds, etc. apply that to everything..
41+
- Example: brushing your teeth for 10 seconds is better than 0 seconds, etc. apply that to everything..

docs/about/me/games.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ A list of games I have, like and played.
1616

1717
## Digital Games
1818

19-
### Playstation Games
19+
### PlayStation Games
2020

21-
A list of playstation games I own:
21+
A list of PlayStation games I own:
2222

2323
| Game | Local Players | Comment |
2424
|------------------------------------|---------------|---------|
@@ -62,9 +62,9 @@ A list of playstation games I own:
6262

6363
### Switch Games
6464

65-
A list of my nintendo switch games:
65+
A list of my Nintendo Switch games:
6666

67-
| Game | Local Player | Comment |
67+
| Game | Local Players | Comment |
6868
|--------------------------------------------------|--------------|-----------------|
6969
| 10 Second Run RETURNS | 4 | zocki? |
7070
| 20XX | 2 | |

0 commit comments

Comments
 (0)