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.

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

First draft sprotty-elk documentation #35

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Conversation

gfontorbe
Copy link
Contributor

First draft for the documentation about sprotty-elk

Copy link

github-actions bot commented Feb 13, 2024

PR Preview Action v1.4.6
Preview removed because the pull request was closed.
2024-02-22 10:10 UTC

@gfontorbe gfontorbe changed the title First draft First draft sprotty-elk documentation Feb 13, 2024
Copy link
Contributor

@jonah-iden jonah-iden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all very nice.
Added some suggestions

hugo/content/docs/sprotty-elk.md Show resolved Hide resolved
hugo/content/docs/sprotty-elk.md Outdated Show resolved Hide resolved

## Preprocessing

Once the SModel has been transformed into an ELK graph, we can apply some preprocessing to the graph. This is done by implementing a class implementing the `ILayoutPreprocessor` interface, and passing it to the constructor of the `ElkLayoutEngine`. The preprocessor class needs to implement a `preprocess` method, which will receive the ELK graph, the Sprotty graph, and the index.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't the info here and in the postprocessing section missing on what symbol to bind these processors?
Or maybe this could be shown in the Bind the LayoutConfigurator to the ContainerModule with an optional comment behind the binding

Signed-off-by: Guillaume Fontorbe <guillaume.fontorbe@typefox.io>
Signed-off-by: Guillaume Fontorbe <guillaume.fontorbe@typefox.io>
@gfontorbe gfontorbe merged commit 60a288f into main Feb 22, 2024
4 checks passed
@gfontorbe gfontorbe deleted the gfontorbe/sprotty-elk branch February 22, 2024 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants