feat: The docs feature is an useful feature

[aigeling]

Really sad to see the docs feature go. I used to rely on it to document business logic. Plus, being able to write scripts directly inside it and execute them as DAG steps allowed me to manage everything right from the DAG UI.

[yohamta0]

Thank you for the feedback. I was under the impression that no one was using it.
Would you mind clarifying this a bit more on the part below? Have you been using it with git-sync?

Plus, being able to write scripts directly inside it and execute them as DAG steps allowed me to manage everything right from the DAG UI.

[sohukia]

Adding my use case here to give some context on why this feature matters beyond a nice-to-have.

I use Dagu to manage infrastructure and security workflows (service accounts, health-check/restart DAGs for third-party tools, GitLab-synced pipelines, etc). In practice, a meaningful part of that work isn't expressible in YAML: it's the reasoning behind a config choice, a workaround for something Dagu can't do natively, or a note on why a step is built a certain way instead of the "obvious" way.

Before this feature, that context lived scattered across README files in the DAG repo, tickets, or my own notes, disconnected from the actual workflow definitions. The Docs page let me keep documentation and DAGs in the same place, versioned together, which made a real difference for onboarding and for my own future self debugging something six months later.

Losing the tab after updating means that context is now either missing or has to move back to an external tool, which defeats the point of having workflows and their documentation co-located.

[aigeling]

I set a subdirectory under docs_dir as the working_dir, and then write scripts in this directory.And then I can execute these scripts in the steps, like this:

steps:
   - name: step-1
      run: $exec TEST/test1.md 
   - name: step-2
      run: $exec TEST/test2.md 

The $exec points to a custom command used to execute scripts, because there are ^M characters in the .md files that need to be handled.It would be even more convenient if the docs feature could be extended to support writing scripts.

[yohamta0]

Thanks for the clarification. It makes me think that what we actually need is a general file explorer and editor like VS Code.