@@ -21,7 +21,47 @@ cd capra-fagradar
2121pnpm 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