Contributing to Taiga - Documentation of the documentation features?

[Donnerstagnacht]

I am trying to contribute to NgDrawFlow. As a first step, I would like to improve the docs a bit.

But I am having a hard time to understand how to use the docs code display components (for example <tui-doc-example>).

What I would like to do are:

1. displaying the code of a component without rendering it (e.g. no preview tab) and instead the typescript tab as default tab

Right now it looks like this:

4. Ideally, I would like to avoid doubling all example components with a .md file. Is there a way to just import a component and use the real code instead of the .md wrapped code?

    public readonly firstNodeExample: Record<string, TuiRawLoaderContent> = {
        TypeScript: import('./examples/first-node/first-node.ts?raw'),
        Component: import('./examples/first-node/first-node.ts?raw'),
        ComponentStyles: import('./examples/first-node/first-node.css?raw')
    };

  <tui-doc-example
      style="padding: 0"
      [content]="firstNodeExample">
  </tui-doc-example>

In general, is there a "docs" of the "docs" page/repo? I only found this which links to a russian doc. ..

[waterplea]

Yes, there's no need to double the files as MD, we do not do that in Taiga UI repo. @a1rat91 if that's something you do in the ng-draw-flaw, is there a reason for it?

As for Preview tab, currently it's required. You would have to rework the example component from @taiga-ui/addon-doc and I'm not sure how to best go around it, it's pretty complex and is used a lot. Are you sure there's no meaningful default tab you could be showing besides code?

The easiest way to hide it would probably to add filtering here so that it is ignored if it's an empty string and then override its name in DI:
https://github.com/taiga-family/taiga-ui/blob/main/projects/addon-doc/components/example/example-get-tabs.pipe.ts

[Donnerstagnacht]

Realized it is used if only a small part of a code should be displayed.

I will display a notification in the preview tab to check the other tabs. Probably, you could provide a setter to the doc-example to set a default tab or is that already possible @waterplea?

[a1rat91]

I may have used MD files in some places to show only what's necessary for a specific example in the demo.

[waterplea]

The idea about hiding default tab is just my first thought on least necessary change into the addon-doc codebase, it's not working like that at the moment.