I have edited the page with some information: https://www.mediawiki.org/wiki/Extension:SimilarEditors

I wasn't able to upload screenshots as it wasn't valid for Wikicommons, then the app refused it because it didn't seem like my own image and then because it seemed unconstructive. I won't fight the wikis.

@AGueyte: Screenshots of free software are valid and welcome on Wikimedia Commons. If there's an image to upload, please feel free to pass it to me via email so I could give uploading a shot, please. Thanks :)

Thank you @Aklapper, I have sent an email with the image!

Thanks. For the records, I uploaded the screenshot to Commons (setting {{free screenshot|license={{MIT}}}}) and made more edits on the extension page.

Thank you @Aklapper!

@AGueyte The installation section looks good - thanks. I've made small change (I removed $wgAddGroups since we don't actually define a 'similareditors' group).

Are you able to add the Usage section, now that the screenshot is available?

For the config section, there are a few more to document - they're in extension.json

Thank you @Tchanders!

I've added the image and updated the config section with the API variables info.

Thanks @AGueyte. I've suggested adding a bit more detail, as in the Special:Investigate documentation and the Special:Investigate help page. @Niharika is writing a help page for SimilarUsers as part of T308581. Could you both sync to work out how much detail should go in each page?

@TThoabala We're interested to hear your thoughts too, and whether there's anything missing from this, as someone who is relatively new to the tool.

I followed all the instruction on that page in and things worked very well for me.
I realised that I get this error

Fatal error: Uncaught ExtensionDependencyError: SimilarEditors requires QuickSurveys to be installed

Other extension have a prerequisites section mentioning the required dependencies. one example being QuickSurveys

Otherwise looks good to me. thank you @AGueyte

Thank you both @Tchanders and @TThoabala.

Are the extra details to add related to explaining the result table columns? If so, I'd need help from Product because I don't have the knowledge for this one!

Good feedback from @TThoabala.

SimilarEditors shouldn't require QuickSurveys to be installed as it's not meant for all wikis. Should we raise this as a bug?

Thanks @AGueyte. I've suggested adding a bit more detail, as in the Special:Investigate documentation and the Special:Investigate help page. @Niharika is writing a help page for SimilarUsers as part of T308581. Could you both sync to work out how much detail should go in each page?

Are the extra details to add related to explaining the result table columns? If so, I'd need help from Product because I don't have the knowledge for this one!

Did you manage to sync with Niharika?

We can access the API documentation through our local setups of the service - or it is documented at this page, which has been shared elsewhere: https://github.com/wikimedia/mediawiki-services-similar-users/blob/main/similar_users/wsgi.py#L142

SimilarEditors shouldn't require QuickSurveys to be installed as it's not meant for all wikis. Should we raise this as a bug?

This first version of SimilarEditors is just for gathering feedback, which it does via QuickSurveys, so we do need it to be installed for now. I think we should add section for prerequisites.

@AGueyte I'm not seeing anything new to review - do you have an unpublished draft?

In T308580#7994642, @Tchanders wrote:

@AGueyte I'm not seeing anything new to review - do you have an unpublished draft?

There was, it appears my edits were reverted.
I see in the ticket's description that only the table of configuration needs to be checked out.
Is there anything else missing from the documentation for now?

In T308580#7999933, @AGueyte wrote:

There was, it appears my edits were reverted.

Numerous edits by an anonymous editor got reverted, in case that is what this refers to. I recommend to add them again (with internal link and lists syntax) from a registered account.

Thank you @Aklapper.

I see in the ticket's description that only the table of configuration needs to be checked out.
The table for SimilarEditors has been added.

The Usage section is checked as done.
I didn't get much feedback from Product, UX, and Research as the column descriptions can be found in the code. Would it make sense to add them to the documentation, too?
Thanks

I recommend to add them again (with internal link and lists syntax) from a registered account.

@AGueyte Have you tried doing this?

I see in the ticket's description that only the table of configuration needs to be checked out.
The table for SimilarEditors has been added.

I've checked this now.

The Usage section is checked as done.
I didn't get much feedback from Product, UX, and Research as the column descriptions can be found in the code. Would it make sense to add them to the documentation, too?

I see that the Usage section got checked, but I think since we are still discussing explaining the columns, we're still working on this for now. I've unchecked it, to be clear.

I think we can consider the documentation improved, and move this task on. Let's keep maintaining the documentation, of course.