How do we enable our users to document their workflows

[merelcht]

In #1293 we decided to remove kedro build-docs. Some of the few users that did use the command expressed the following:

• "It's more like a bonus for us than a real need. I like to provide to my team both auto generated doc and dag (w/ kedro viz), it help us understend each pipe/node." Are the docs generated as you expect? "Yes, I currently never encountered any issue relating to the auto-generated documentation" Is it enough to fulfil my needs? "Yes and no, the doc + the dags is great but it would be amazing to have a in-doc view of the dags (like this, no need to share screenshots of the viz)"
• "I use it to document the pipelines I build and make the onboarding process smoother. I'm working for a university and apart from few others the majority of my colleagues are staying for 6 months to 3 years. The DAG and the docs makes it easier for them to understand the structure and quickly start working on the pipelines. [...] it would be cool to have the dag in the docs (maybe mermaid kind of dag that can be version controlled? 🙂 )".

This alludes to users having a need to document their workflow but not exactly as kedro build-docs did for them. We need to investigate what it is that users need.

[noklam]

From Tech Design 2022-08-31

• Create a new issue to document how users can build the docs with sphinx or other alternatives

• It may worth to split into a kedro tool or a community plugin, it can be an exercise for a community hackathon

Side note:

• Check if we are doing deprecation warning, may reference to padnas @deprecate style of deprecation.

[merelcht]

Related issue: #2075

[merelcht]

Closed in favour of #2114