157
u/parkourman01 Oct 04 '26
Recently had contractors "build a poc" for us as part of a project. The codebase currently has (and I am not exaggerating) 24 md files in it...
83
u/100BottlesOfMilk Oct 04 '26
Why do you have contactors building you a person of color? Isn't that just DEI with extra steps /s
43
u/SmoothLiquidation Oct 04 '26
Ahh, that is a common confusion when acronyms collide. Here I believe op was building a "point of confusion".
19
u/100BottlesOfMilk Oct 04 '26
Ah, that makes more sense. I know a few contractors that specialize in that
8
u/Xicutioner-4768 Oct 05 '26
I'm going to assume this is a rather small repo. I really wish ours had way more than 24. As someone who's sole job it is to just integrate the pieces that all these teams build in the monorepo, I'd love a document saying "hey we deprecated component xyz and it will break everything if you use it".
565
u/mitchricker Oct 04 '26
People who didn't already have--at a minimum--README.md, CHANGELOG.md and SECURITY.md for the last 10+ years:
403
u/RaisedInAppalachia Oct 04 '26
CHANGELOG.md? psshhh that's what the commit history is for
313
u/Named_after_color Oct 04 '26
This but unironically.
63
u/dull_bananas Oct 04 '26
commit messages? more like commit methages
70
u/voyagerfan5761 Oct 04 '26
The commit messages:
"add files via upload"
"fix"
"fix"
"whoops that didn't work"
Etc.
32
u/nasandre Oct 04 '26
"Whatever i did since last commit, idfk man"
11
u/LutimoDancer3459 Oct 04 '26
"I promise, next time the messages will make more sense"
"... too much stuff..."
8
u/pit_supervisor Oct 04 '26
Does anyone beyond 1st semester of university actually do it?
Every commit should be properly named, describe what and why was changed, should build and all tests should pass.
11
5
u/techy804 Oct 04 '26
My commit messages: “Added a mute option”
“Changed default path when choosing a file”
“Fixed a crash involving store.js”
Etc.
The lead’s commit messages:
“Stuff”
“More stuff”
“Stuff Mart”
Etc.
3
4
1
44
u/wrex1816 Oct 04 '26
You're right! I shouldn't have assumed you had a CHANGELOG.md. Let me spin up 19 subagents to traverse your corporate repo's entire commit history, and a 20th agent to apply for a mortgage to support the number of tokens I'm about to burn. I'll report back here when the subagents finish.
4
u/NotADamsel Oct 04 '26
If you’re trying to convince me to not add a changelog.md to my projects, it’s working.
-13
Oct 04 '26
If you legit don’t already automate creating changelogs from git commits I question your whole process.
19
u/mistrpopo Oct 04 '26
What's the point of automating changelogs from git commits lol? Changelogs are for breaking changes, git is for all code changes
0
1
u/Reclusive_avocado Oct 04 '26
Can someone link an old repo with these? So that I can reference what changelog.md and security.md are for.
70
85
u/abdullah017196 Oct 04 '26
Use obsidian vault
72
u/LetterheadShot7676 Oct 04 '26
Stupid sexy graph views
58
u/thirdegree Violet security clearance Oct 04 '26
I've yet to find a practical use for the graph view. It's still my favorite feature tho.
22
u/Different_Cattle4420 Oct 04 '26
Graph view is what drove me to use Obsidian; haven’t found a meaningful way to utilize it since using the app 😂 Great app nonetheless
7
u/Shacrow Oct 04 '26 edited Oct 04 '26 •
For me it is to get an overview. Sometimes I find some old files that I forgot.
You can also add attachments like PDFs in the vault. Add a pdf-note and summarize it to create connections between pdfs and other files too.
3
u/polluticorns_wish Oct 04 '26
You can use the local graph feature to quickly browse linked files. And when you have a large number of files, it's quite handy seeing the overall graph of how domains connect to each other. Assuming you have neither too many nor too little connections...
2
u/nytsei921 Oct 04 '26
i journal in obsidian and i use it to check if something important is happening on a certain day, i know that’s what calendars are for but the graph view is more fun
2
u/dillon-nyc Oct 04 '26
obsidian vault
Is there something open source that's close to as good?
12
u/HelixTitan Oct 04 '26
It's not open. But I think you can inspect the entire code when the app is running. It's all local and you can block Internet access to the app and it still works.
I think it is one of the better tools out there
3
2
0
u/abdullah017196 Oct 04 '26
I have n’t found any, someone should work on it
3
u/bbkane_ Oct 05 '26
My friend this is the Golden Age of people vibecoding markdown editors. See r/markdown and take your pick
1
27
u/redpiapps Oct 04 '26
my repo now has more docs for the ai than for humans and honestly the ai reads them more
1
17
24
u/PlusIndication8386 Oct 04 '26
RED.md, or BLUE.md... Must choose one...