Discussion: Join Wagtail Nest / merge with Wagtail Math

[lb-]

Hi. I'm not sure if this is something that would be worth discussing but would there be interest for this package to move to Wagtail Nest. I'm on the Wagtail core team and see that this kind of package looks useful to the community and may need a bit more community support to keep updated.

Additionally, there is a similar package Wagtailmath (uses the MathJax engine) that maybe could be merged together when bringing into the Nest group.

There may even be a desire to support multiple 'text to diagram' engines like Mermaid / Pintora under one package banner.

Let me know if you would be interested. The Wagtail Nest documentation explains what this would mean.

https://github.com/wagtail-nest

[lb-]

Posted a similar question on Wagtail math. wagtail-nest/wagtail-polymath#11

[ongchi]

Hi. I'm not sure if this is something that would be worth discussing but would there be interest for this package to move to Wagtail Nest. I'm on the Wagtail core team and see that this kind of package looks useful to the community and may need a bit more community support to keep updated.

Additionally, there is a similar package Wagtailmath (uses the MathJax engine) that maybe could be merged together when bringing into the Nest group.

Hi, thank you for your invitation, that sounds good.

There may even be a desire to support multiple 'text to diagram' engines like Mermaid / Pintora under one package banner.

I've been thinking about this before, and I think something like Vega-Lite would also be worth supporting. But it's not urgent to me, I'll just keep it on my list but haven't found some time to implement it yet.

[lb-]

That's great news @ongchi - would you rather both packages get moved to Wagtail Nest (this one and Wagtail Math) or are you OK to merge this repo's code into a new repo/project that will support both MathJax and Katex?

My thinking is that will be easier for a community, including yourself and the author of Wagtail Math to have one text to diagram/math package instead of multiple.

Either way, you would still be an author and have permissions to merge in the new repo but a few of us would have to help each other to get the code into a place that aligns with the Wagtail cookie cutter approach.

[ongchi]

Hi @lb- ,

I think it's reasonable to merge this package into Wagtail Math and make the package support both KaTeX and MathJax rendering engines. This could be done by providing separate components or a config variable to let users decide.
From my vague memory, rich text fields save both raw text and rendered HTML to the database, correct me if I'm wrong. So maybe this should be provided as separate components.
I don't have time recently. Anyone willing to contribute is also welcome. Alternatively, I could find a weekend, maybe in December, to get this done.

[lb-]

Thank you for being up for a merge of functionality, we would 100% love to get your support in this and hopefully with a few others from the community involved it wont be as difficult to keep the project maintained as Wagtail continues to release changes.

As the next step I will raise a new discussion on the Wagtail Nest repo, get feedback on the naming and then we can working through the migration/merging.

[lb-]

https://github.com/orgs/wagtail-nest/discussions/3 discussion raised - would love any input on naming and process if you have a bit more time to chime in @ongchi

[lb-]

@ongchi - quick update.

Wagtail-math has now moved to https://github.com/wagtail-nest/wagtail-polymath/

I have invited to you to be a member of that repo if you are up for helping merge your code into that repo (we will work out the details of this a bit later).

[lb-]

@ongchi just wondering if you are still keen on being involved with this migration/merging in some form.

[ongchi]

@ongchi just wondering if you are still keen on being involved with this migration/merging in some form.

Oh! Sorry, I completely forgot about this project for a while.
I think I can merge this codebase into wagtail-polymath at least, and support both MathJax and KaTeX backends.

[lb-]

Great @ongchi I have added you as a maintainer on the repo.

Not sure on how we can coordinate next steps, we do have a Wagtail package guidelines which we would probably want to start to work towards at some point.

https://github.com/wagtail/wagtail/wiki/Python-Package-Maintenance-Guidelines

[ongchi]

Here is my short-term plan for this project:

1. Merge wagtail-katex codebase into wagtail-polymath first, start from this branch, and make sure everything works fine.
2. Apply overall project style using Wagtail Cookie Cutter.
3. Measure the implementation of the guidelines.

[lb-]

Awesome

[zerolab]

@ongchi fwiw, I've opened wagtail-nest/wagtail-polymath#12 to add support for Wagtail 5.2+. It also aligns it to the wagtail-nest guidelines.

I did not rename it to wagtail_polymath yet, but it is worth syncing up the efforts to merge things

[ongchi]

Hi @zerolab, many thanks for your effort.

The wagtail-polymath's render engine is different from wagtail-katex, so before merging the two projects into one, I did some experiments to support both MathJax and KaTeX for wagtail-polymath and wagtail-katex.

I believe we could start to merge this project into wagtail-polymath with a few modifications after wagtail-nest/wagtail-polymath#12 is merged.

[zerolab]

Thank you @ongchi

wagtail-nest/wagtail-polymath#12 is now merged

[lb-]

Awesome!