adding new filter configuration docs...

[Jim Hargrave]

The okapi filter wiki was originally designed to support the okapi applications like Rainbow. The wiki is often not updated when new filter parameters are added or removed. This leads to a lot of confusion and questions.

What we really need is a wiki that lists all the current filter parameters and how they are used. Not application oriented, but config file oriented. I'm going to use AI and go through each filter and create a markdown file that can be used to help with that filter's configuration. Filter configuration is very, very complex and this knowledge needs to be preserved and kept up to date with filter changes.

Ideally we want the code to be self documenting - we have had many discussions on this topic. But we don't have the resources to make those changes - this is the next best option.

I'll create a PR for each filter. Will introduce a doc directory with minimally a single markdown file. Might be nice to have links to the specific code etc.. Style and format can evolve with feedback. Using Opus 4.5 - lets see how smart it is.

Thoughts?

Jim

[Jean-Christophe Helary]

> Thoughts?

Excellent idea.

JC

> --
> You received this message because you are subscribed to the Google Groups "okapi-devel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to okapi-devel...@googlegroups.com.
> To view this discussion visit https://groups.google.com/d/msgid/okapi-devel/a423553f-af2e-444d-8176-f0dfc734bdc5%40gmail.com.

--
Jean-Christophe Helary
https://sr.ht/~brandelune/

[Asgeir Frimannsson]

Hi all,

On leave this week and catching up a bit on an old friend (okapi). Just to give ideas, I asked AI for a json schema for the filters based on the source code and docs, and a way to configure these in a nice UI based on these schemas.

https://asgeirf.github.io/okapi-filter-params/#/ (via https://github.com/asgeirf/okapi-filter-params/blob/main/src/data/filters.json )

Cheers,

asgeir

To view this discussion visit https://groups.google.com/d/msgid/okapi-devel/5B67B0AB-DED5-4E39-B8DC-0026BDCB163E%40traductaire-libre.org.

[Jim Hargrave]

It's been a long time old friend! This is exactly what we have been wanting. Especially if you add full validation. 

Maybe instead of starting with markdown this is a better way to go - more useful and the schema can be used for multiple purposes - including documentation!Jim

To view this discussion visit https://groups.google.com/d/msgid/okapi-devel/CAJe-TVvXj2ktpz5KSBoLsZ3Wu1r_0V_OWUTtty7YNQS76v5VTA%40mail.gmail.com.

[Asgeir Frimannsson]

Hi all,

Denis mentioned in the call the possibility of combining the existing wiki-data into this. I did an experiment and it's a good start, live on the site now. Includes some information pop-ups on properties, descriptions as well as examples. I also added two experiments on UI-creation, one uses the generated schemas to create a ui, while the other tries an auto-conversion of the SWT-panels to React.

Fun way of catching up with Okapi. I will share the schema-generation code etc soon, it's in a different project and I haven't had time to extract it.

cheers,

asgeir

[Jim Hargrave]

Very useful!!! Thanks.

Jim

To view this discussion visit https://groups.google.com/d/msgid/okapi-devel/CAJe-TVs_THmNcTjm1sJ%3Duj3UzDM%2B0eJnD%3DdTOKxnG%3DevpeVLTQ%40mail.gmail.com.