Missing api history

[DCzajkowski]

Old version of the docs supported API history by appending /history to the URL.

For example, from /api/desktop-capturer you could do /api/desktop-capturer/history to get the history of changes of that module.

Are there any plans to implement these pages in the new docs?

[molant]

For reference this is what the history looks like for app in the old site:

@DCzajkowski, what information are you searching when accessing this page?
I want to know if we should reimplement it as it was or if there is more work we should do.

Thanks!

[DCzajkowski]

@molant thank you for the screenshot and a quick reply!

Recently, I used it to see at which version a "net" module was introduced.

If I had to point a general use-case I'd say being able to look up documentation for previous versions without the need to go through git.

We are using Electron on an older version due to some incompatibilites with some packages we are using. We may migrate/upgrade soon, but it's still beneficiary to be able to read documentation at the point of our version and see what the changes in particular modules were introduced.

As you know some APIs have been deprecated in newest versions and documentation for these functionalities is pretty hard to find. Maybe there is a way I am not aware of?

Anyway, thanks for taking it into consideration ☺️

[molant]

If I had to point a general use-case I'd say being able to look up documentation for previous versions without the need to go through git.

We are working on adding versioned docs:

There are still a couple things to polish but they should start showing up soon-ish. Would that be OK?

Recently, I used it to see at which version a "net" module was introduced.

We could add a field in each API that tells you when it was added. Would that solve your use case?
Personally, we could also add when there have been changes (especially breaking). Need to figure out if electron-api-historian can provide that information though.

Happy to chat 1:1 more about this! We know the upgrade process is not always smooth and we want to make it easier!

[DCzajkowski]

We are working on adding versioned docs: […] Would that be OK?

I think so, yes 🙂

We could add a field in each API that tells you when it was added.

I think that would be enough, yes, but there may be specific functions added in versions later than the module itself. Something to bare in mind.

I remember Vue docs have this. https://v2.vuejs.org/v2/api/#warnHandler
Here a specific function is marked as "added in x".

Happy to chat 1:1 more about this!

Sure! But I am not sure if I can provide a lot of information. But if you feel like you could benefit from such chat then let's do this!