search

metafacture / metafacture-documentation

The central place for documentation about metafacture
http://metafacture.github.io/metafacture-documentation/
Apache License 2.0
3 stars 3 forks source link

Add filter to table #52

Open dr0i opened 1 month ago

dr0i commented 1 month ago

Proof of concept - WIP

Question is: is this HTML table useful? from metafacture/metafacture-core#369:

Add filtering support in flux-commands.md, e.g. generate filter 'buttons' for each type as input and output, e.g. ->StreamReceiver for all decoders, StreamReceiver-> for all encoders, etc.

Would this HTML table provide the needed functionality?

dr0i commented 1 month ago

Provides a sortable HTML table.

To test: checkout the branch and point your browser's URL to: file:///$yourHomePath/$repoPath/metafacture-documentation/docs/flux/flux-commands-table.html

dr0i commented 1 month ago

Would this simple HTML table provide the needed functionality?

Thinking about it - no. We indeed need filter.

dr0i commented 1 month ago

The HTML table comes now with filter for the signature. The name column is sortable. To test proceed as described in https://github.com/metafacture/metafacture-documentation/pull/52#issuecomment-2441586121 .

TobiasNx commented 4 weeks ago

I thinik this table is cool, but I do not know If we should duplicate the documentation. Also the page should be implemented into the just-the-docs template. Perhaps we should only add the name of the function linking to the documentation and the sig in and sog out column.

dr0i commented 4 weeks ago

Discussed with @maipet and @TobiasNx we should try to integrate the table into our documentation, at best instead of https://metafacture.github.io/metafacture-documentation/docs/flux/flux-commands.html. What's missing: