Skip to content

Commit 55273ca

Browse files
committed
Put .obsidian on top of gitignore, update readme
1 parent 6eca034 commit 55273ca

File tree

2 files changed

+47
-8
lines changed

2 files changed

+47
-8
lines changed

.gitignore

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Manually added section
2+
.obsidian/
3+
14
# Created by https://www.toptal.com/developers/gitignore/api/macos,windows,linux,node,visualstudiocode
25
# Edit at https://www.toptal.com/developers/gitignore?templates=macos,windows,linux,node,visualstudiocode
36

@@ -237,8 +240,4 @@ $RECYCLE.BIN/
237240
# Windows shortcuts
238241
*.lnk
239242

240-
# End of https://www.toptal.com/developers/gitignore/api/macos,windows,linux,node,visualstudiocode
241-
242-
# Editor-specific folders
243-
.obsidian/
244-
.vscode/
243+
# End of https://www.toptal.com/developers/gitignore/api/macos,windows,linux,node,visualstudiocode

Readme.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,47 @@ cd capra-fagradar
2121
pnpm dev
2222
```
2323

24-
---
25-
# How to contribute
24+
## Updating contents
2625

27-
This section is under development.
26+
Content is found in two folders;
27+
28+
- `src/technical-radar`
29+
- `src/tech-leader-radar`
30+
31+
The files themselves are .mdx files, using .yaml frontmatter for configuration.
32+
These are the config values:
33+
34+
- `id`: unused
35+
- `name`: what it says on the tin
36+
- `depth`: 1-4. See `src/om-fagradar.mdx` for info on the depth levels
37+
- `qudrant`: which named quadrant to put this item in. Quadrant names are set in `index.tsx` for both radars (`const quadrants = [...]`)
38+
39+
Editing can be done in two ways:
40+
41+
1. Using an IDE
42+
1. Using [Obsidian](https://obsidian.md/)
43+
44+
If you have not heard of Obsidian before, you can read about them [here](https://obsidian.md/about)
45+
46+
### How to actually update the contents
47+
48+
#### With an IDE
49+
50+
Requirements: IDE installed, git configured
51+
52+
1. Clone the repo
53+
2. Open it with your IDE
54+
3. Do the changes in the most likely very mediocre markdown editor
55+
4. Commit using your preferred git tool
56+
57+
#### With Obsidian
58+
59+
Requirements: Obsidian installed, git configured
60+
61+
1. Clone the repo
62+
2. Open `src/` as a vault in Obsidian
63+
3. Do the changes with a kick-ass editor
64+
4. Commit using your preferred git tool
65+
66+
To be able to edit the .mdx files you need to install the Obsidian community plugin "mdx as md".
67+
Obsidian also has a very popular Git plugin, if you don't want to do git on the outside.

0 commit comments

Comments
 (0)