Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add graphical graphs to docu flux #498

Open
dr0i opened this issue Sep 18, 2023 · 2 comments
Open

Add graphical graphs to docu flux #498

dr0i opened this issue Sep 18, 2023 · 2 comments
Assignees
@TobiasNx @maipet

Comments

@dr0i
Copy link
Member

dr0i commented Sep 18, 2023

Create a graphical graph out of https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md regarding the signature . This could help people to understand what modules can be chained.
@dr0i dr0i changed the title Add GUI graphs to docu flux Add graphical graphs to docu flux Sep 18, 2023
@dr0i dr0i self-assigned this Sep 18, 2023
@dr0i dr0i added this to Metafacture Sep 18, 2023
@dr0i dr0i moved this to Backlog in Metafacture Sep 18, 2023
@fsteeg
Copy link
Member

fsteeg commented Sep 18, 2023

We were planning a slightly different approach to improve flux commands documentation in metafacture/metafacture.github.io#10.

dr0i added a commit that referenced this issue Oct 21, 2024
@dr0i
Adjust the structure of '@description' (#498)
14c81a0 
Working on #498 revealed that the "Description" annotation consists of
one line always. This helps to parse the generated flux-commands.md.
@dr0i dr0i moved this from Backlog to Working in Metafacture Oct 25, 2024
@dr0i dr0i mentioned this issue Oct 25, 2024
Closed
dr0i added a commit that referenced this issue Oct 25, 2024
@dr0i
Complete annotations used by flux-commands (#498)
cb35ebf
@dr0i dr0i mentioned this issue Oct 25, 2024
Open
@dr0i
Copy link
Member Author

dr0i commented Oct 25, 2024 •
edited
Loading

Added a branch which helps to generate such a graphical graph presentation.

It seems rather unlikely that this graph is helping users to find what is to be piped to what.
Maybe the SVG can serve as ... something? It show how many flux modules we have. It shows the complexity when it comes to piping.
WDYT @TobiasNx and @maipet ?

@dr0i dr0i assigned TobiasNx and maipet and unassigned dr0i Oct 25, 2024
@dr0i dr0i moved this from Working to Review in Metafacture Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TobiasNx TobiasNx

@maipet maipet

Labels
None yet
Projects
Metafacture
Status: Review
Milestone
No milestone
Development

No branches or pull requests
4 participants
@fsteeg @dr0i @TobiasNx @maipet