Electron-packager: API documentation missing

Created on 4 Jun 2020  路  5Comments  路  Source: electron/electron-packager

Preflight Checklist

  • [x] I have read the contribution documentation for this project.
  • [x] I agree to follow the code of conduct that this project follows, as appropriate.
  • [x] I have searched the issue tracker for a bug that matches the one I want to file, without success.

Issue Details

Expected Behavior

Clicking on "API" at the top of the Readme should bring me to the API documentation.

Actual Behavior

Clicking on "API" at the top of the Readme brings me to this.
Which is the same as the Readme. Clicking on "API" there brings me to the same page.

Additional Information

https://github.com/electron/electron-packager/blob/master/docs/api.md says the API documentation has moved. Clicking on this link there also redirects me to the page mentioned above.

I could also find nothing in the "Community" section of Electron. Particularly frustrating that when trying to open an issue about this in this repo, it asks me to go there to ask questions about usage, only that that site is a general Electron site. Clicking on electron-packager there redirects me here again.

I initially wanted to look at the API documentation because I wanted to do something similar to what is mentioned here: https://github.com/electron/electron-packager/issues/743#issuecomment-340656467, but alas that link led me to this never ending annoyance.

So where is the API documentation? Also I request that these links please be fixed.

documentation question

All 5 comments

馃憢 Thanks for opening your first issue here! If you have a question about using Electron Packager, read the support docs. If you're reporting a 馃悶 bug, please make sure you include steps to reproduce it. Development and issue triage is community-driven, so please be patient and we will get back to you as soon as we can.

To help make it easier for us to investigate your issue, please follow the contributing guidelines.

Click on "electronPackager" in the right sidebar. Typedoc (the documentation generator we use) pulls in the repository's README.

That did not occur to me. Not very obvious. But I guess I could have clicked on more random places. Thanks nonetheless.

I've also edited my comment there to point to the API docs as they looked at the time that comment was written.

Nice, yeah I could've looked back in time as well and check out the version history of api.md.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Liam-Ryan picture Liam-Ryan  路  4Comments

pushkin- picture pushkin-  路  4Comments

TongDaDa picture TongDaDa  路  3Comments

Orrison picture Orrison  路  3Comments

caishengmao picture caishengmao  路  3Comments