🔧 Repository: tech-insights setup documentation incomplete
jackmtpt opened this issue · 13 comments
📜 Description
This readme contains some instructions for setting up tech-insights with the new backend, but not everything is covered e.g. how to register the fact checker.
👍 Expected behavior
Everything should be documented for the new backend, and optionally for the old backend as well.
👎 Current Behavior
Not everything has docs for the new backend
👟 Reproduction steps
n/a
📃 Provide the context for the Bug.
No response
👀 Have you spent some time to check if this bug has been raised before?
- I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
- I have read the Code of Conduct
Are you willing to submit PR?
None
Contributions welcome 👍
As soon as I figure out how to do it I can write something...
I'd love to know it as well how to do it, is the last plugin that I have in the old BE but I have a lot of custom checks to migrate.
I remember asking about this in Discord but I never had time to dig into it, this is part of what they replied:
The extension point is:
let factCheckerFactory:
| FactCheckerFactory<TechInsightCheck, CheckResult>
| undefined = undefined;
env.registerExtensionPoint(techInsightsFactCheckerFactoryExtensionPoint, {
setFactCheckerFactory<
CheckType extends TechInsightCheck,
CheckResultType extends CheckResult,
>(factory: FactCheckerFactory<CheckType, CheckResultType>): void {
factCheckerFactory = factory;
},
});
Where you can add your own fact check factory. That allows you to implement that interface with your own implementation.
and this is the link to the discord discussion :)