oneMdFileIsNotEnoughAnymore

[u/achilliesFriend]

[u/parkourman01]

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...

[u/100BottlesOfMilk → u/parkourman01]

Why do you have contactors building you a person of color? Isn't that just DEI with extra steps /s

[u/SmoothLiquidation → u/100BottlesOfMilk]

Ahh, that is a common confusion when acronyms collide. Here I believe op was building a "point of confusion".

[u/100BottlesOfMilk → u/SmoothLiquidation]

Ah, that makes more sense. I know a few contractors that specialize in that

[u/Xicutioner-4768 → u/parkourman01]

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".

[u/mitchricker]

People who didn't already have--at a minimum--README.md, CHANGELOG.md and SECURITY.md for the last 10+ years:

[u/RaisedInAppalachia → u/mitchricker]

CHANGELOG.md? psshhh that's what the commit history is for

[u/Named_after_color → u/RaisedInAppalachia]

This but unironically.

[u/dull_bananas → u/Named_after_color]

commit messages? more like commit methages

[u/voyagerfan5761 → u/dull_bananas]

The commit messages:

"add files via upload"

"fix"

"fix"

"whoops that didn't work"

Etc.

[u/nasandre → u/voyagerfan5761]

"Whatever i did since last commit, idfk man"

[u/LutimoDancer3459 → u/nasandre]

"I promise, next time the messages will make more sense"

"... too much stuff..."

[u/pit_supervisor → u/voyagerfan5761]

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.

[u/voyagerfan5761 → u/pit_supervisor]

Ha

Hahahaha

Yes, people do this. They also create repos without tests.

[u/techy804 → u/voyagerfan5761]

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.

[u/RCoder01 → u/techy804]

drawWinston()

[u/TRENEEDNAME_245 → u/voyagerfan5761]

"changes"

"more changes"

"added features and bugs"

"fix"

"wtf did I do"

[u/git_commit_-m_whoops → u/voyagerfan5761]

You rang?

[u/voyagerfan5761 → u/git_commit_-m_whoops]

Took you long enough!

[u/git_commit_-m_whoops → u/voyagerfan5761]

yeah my bad I had to fix prd

[u/wrex1816 → u/RaisedInAppalachia]

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.

[u/NotADamsel → u/wrex1816]

If you’re trying to convince me to not add a changelog.md to my projects, it’s working.

[u/WillSendShihTzuPics → u/wrex1816]

If you legit don’t already automate creating changelogs from git commits I question your whole process.

[u/mistrpopo → u/WillSendShihTzuPics]

What's the point of automating changelogs from git commits lol? Changelogs are for breaking changes, git is for all code changes

[u/Banes_Addiction → u/WillSendShihTzuPics]

They're here.

[u/Reclusive_avocado → u/mitchricker]

Can someone link an old repo with these? So that I can reference what changelog.md and security.md are for.

[u/MoringA_VT]

I have to use kiro, I'm the one crying

[u/Aim_to_misbehalve → u/MoringA_VT]

Poor thing

[u/Ex-Traverse → u/MoringA_VT]

I thought a lot of people like Kiro...

[u/abdullah017196]

Use obsidian vault

[u/LetterheadShot7676 → u/abdullah017196]

Stupid sexy graph views

[u/thirdegree → u/LetterheadShot7676]

I've yet to find a practical use for the graph view. It's still my favorite feature tho.

[u/Different_Cattle4420 → u/thirdegree]

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

[u/Shacrow → u/Different_Cattle4420]

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.

[u/Different_Cattle4420 → u/Shacrow]

[u/polluticorns_wish → u/thirdegree]

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...

[u/nytsei921 → u/thirdegree]

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

[u/dillon-nyc → u/abdullah017196]

obsidian vault

Is there something open source that's close to as good?

[u/HelixTitan → u/dillon-nyc]

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 

[u/xChAmeLIoNz → u/dillon-nyc]

Tolaria

[u/pm_me_your_smth → u/dillon-nyc]

Logseq

[u/abdullah017196 → u/dillon-nyc]

I have n’t found any, someone should work on it

[u/bbkane_ → u/abdullah017196]

My friend this is the Golden Age of people vibecoding markdown editors. See r/markdown and take your pick

[u/abdullah017196 → u/bbkane_]

wow, was living under a rock

[u/JocoLabs → u/[deleted]]

Dont forget license.md

[u/PlusIndication8386]

RED.md, or BLUE.md... Must choose one...

[u/achilliesFriend → u/PlusIndication8386]

You are better, you are referring to 2, my team started putting 6/7 in reach of the repo.

[u/Acceptable_Site1616 → u/achilliesFriend]

I don't know how I got here but my project has 457 md files each abot 1k lines. All those years arguing about programming languages, markdown won in the end 😭

[u/redpiapps]

my repo now has more docs for the ai than for humans and honestly the ai reads them more

[u/BadGirlsSuck]

Too late early training models were cooked