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

Documentation of Update button needs more info #2349

Open
athulin opened this issue Jan 1, 2025 · 1 comment
Open

Documentation of Update button needs more info #2349

athulin opened this issue Jan 1, 2025 · 1 comment

Comments

@athulin
Copy link

athulin commented Jan 1, 2025

Describe the enhancement

In the documentation of the Update button, add information about what CAPI information is requested, and to what endpoints that information is sent. In particular, is it sent to plugins also?

Additional context

The question arose from a question on Reddit, where a user asked how he could ensure that an Exobio discovery was reported to the Canonn database. The question then became if the update info will be resent to the EDMC Canonn plugin, or if it only sent to the EDDN/EDSM/Inara endpoints (assuming they're enabled).

As the current documentation doesn't seem to say what EDMC does on Update, I suggest the clarification should be added.

@Athanasius
Copy link
Contributor

With regards to plugins, it's in the plugin developer documentation: https://github.com/EDCD/EDMarketConnector/blob/main/PLUGINS.md#data-from-frontier-capi

More generally there are resources like https://siriuscorp.cc/contributing.html

But, sure, maybe user-facing EDMC documentation could be better about this. I'm sure contributions are welcome (but as that's in the Wiki you can't do a PR, sucks eh ?).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants