Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

tl;dr generate documentation based off of the code automatically.

My solution might be more applicable to back end python dev (not sure about frontend or other languages), but where I work we have 2 systems for generating documentation based off of code.

1. OpenAPI specs. All our code uses the generated clients. 2. I built a system that has a step in CI/CD that checks the docstrings of the functions/methods to make sure it matches the mypy-enforced function signature, along with some other regex-filters.

As for more high level interactions between software (like a graph view of connected pieces of code), you would probably have to use an LSP which could get hairy.

As for the confluence part, there's probably a working terminal interface (3rd party tool, haven't tried any) that would let you upload the result of all that.



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

Search: