For the best experience on desktop, install the Chrome extension to track your reading on news.ycombinator.com
Hacker Newsnew | past | comments | ask | show | jobs | submit | history | marttilaine's commentsregister

> When someone wants to contribute without understanding the code workflow, he should not contribute.

There are definitely many projects where you don't need to understand every single aspect of the codebase to be able to contribute a meaningful fix or even a feature.

It benefits the contributor and the project if they have a simple pointer to e.g. where the application logic code is, or where the distribution-related code is, etc.


I experimented with something similar in one of my larger side projects a couple of years ago:

https://github.com/shipmight/shipmight/blob/master/src/ARCHI...

At the top of each file there was a tree of links to other ARCHITECTURE.md-files in the repo, like this:

    * ARCHITECTURE.md <- you are here
    * backend/ARCHITECTURE.md
        * backend/api/ARCHITECTURE.md
        * backend/cli/ARCHITECTURE.md
        * backend/ui/ARCHITECTURE.md
        * backend/utils/ARCHITECTURE.md
    * frontend/ARCHITECTURE.md
    * internal-charts/ARCHITECTURE.md


A README.md in each package/module/top-level directory is also rendered by GitHub's UI in the file list at the bottom (in locations like this: https://github.com/shipmight/shipmight/tree/master/src/backe...), I've seen this in some projects as well.


For anyone struggling with Helm YAML syntax errors in their day job, I shamelessly advertise my browser-based debug tool Helm Playground:

https://helm-playground.com/ - https://github.com/shipmight/helm-playground


Hey, I used this the other day. Thank you.


Thanks for the tip about Lucidchart line drawing, will check out how they do it.

What would you imagine as the optimal AI workflow? Iassume it's more complex than just issuing commands like "move AWS-section under Infrastructure"?


Yes, it's planned! My knowledge on distributing a Linux desktop app is a bit limited, but I plan to add .deb and .rpm releases soon.


There is potential to import and export DOT and e.g. Mermaid. Of course the editor functionality would be limited to what those formats support, and diagram layout would not be exported 1-to-1, as it's recalculated by the renderer of that format eventually. These are not on the immediate roadmap.


Hmm. Not able to reproduce this issue. Do you see the clipboard icon turning to checkmark on the second copy too? If not, then the browser blocked the second clipboard operation.


Thanks for reporting! Fixed.


Sorry about this, was an oversight. Should not do that anymore!


Thank you all for the feedback on this! I agree. It didn't seem like such an issue during development, but that was a misjudgement. Removed that functionality now. Should not add to history anymore (shareable URLs should still work).


Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search:

HN For You