This topic was automatically generated from Slack. You can find the original thread here.
Hi everyone, happy new year to the Pipedream community
While working on several Pipedream projects (around 8 so far), I spent a lot of time writing documentation manually. To make this easier, I built a small internal app for me and my team.
The idea is simple: it helps generate documentation from a Pipedream project.
There are two modes:
• Raw mode: exports all code steps into a clean, well-structured Markdown file (easy to reuse or feed into an LLM later)
• AI mode: processes those code steps with prompts to generate full project documentation automatically
I’ve been using it for my own work and my colleagues have found it really useful.
Would this be something you’d be interested in?
And if yes, would you prefer using it through a visual interface or via an API?
I’m pretty sure most of you will want api
In the team we use it by api to update the doc weekly. You could also do some fancy ops and send the documentation to mintlify or something like that. I’m sure you guys can figure out some pipedream workflows to achieve what you want in the end.
From chats with my team and a few folks I spoke to, it sounds like most interest is around the API interface.
I’m curious to get a clearer signal though quick poll
What would you find most useful for documentation generation?
Structured project output (code steps while keeping order of project and different workflows) Fully processed output generated by an LLM (explanation of each workflow and entire project + graphs) Both
Structured project output (code steps while keeping order of project and different workflows)
Fully processed output generated by an LLM (explanation of each workflow and entire project + graphs)
Both
