Open
Description
Currently running through docs-parser to see if it could be adapted to something like Node.js's docs. Here's a set of things that I've found to be highly electron-focused:
- Output file is by default called
electron-api.json
.- Possible resolution: default to
api.json
and provide a CLI flag to change the name to something custom (likeelectron-api.json
ornode-api.json
).
- Possible resolution: default to
- Website URL is hardcoded to
electronjs.org
- Possible resolution: have a project config that can define this.
- Possible resolution: don't include unless CLI flag is passed or a project config exists.
- Repo URL is hardcoded to
electron/electron
- Possible resolution: have a project config that can define this.
- Possible resolution: don't include unless CLI flag is passed or a project config exists.
- Process property exists in the root of the JSON output where it may not be useful for anything outside of Electron.
- Possible resolution: opt-in to including this via flag/config.
Metadata
Metadata
Assignees
Labels
No labels