-
Notifications
You must be signed in to change notification settings - Fork 15.7k
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
document the process(es) in which APIs are available #7843
Conversation
What about these metadata fields?
|
Planning to tackle those separately from this PR. |
@@ -2,6 +2,8 @@ | |||
|
|||
> Perform copy and paste operations on the system clipboard. | |||
|
|||
Processes: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer Processes
-> Process
Ready for 👁 👁 |
@@ -2,6 +2,9 @@ | |||
|
|||
> Retrieve information about screen size, displays, cursor position, etc. | |||
|
|||
Process: [Main](../tutorial/quick-start.md#main-process), | |||
[Renderer](../tutorial/quick-start.md#renderer-process) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super duper minor, but looks like most places in the diff put both processes on a single line, but this one (and shell.md
) split it over two lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
The docs linter currently contains a seeds file that lists all APIs and some extra metadata for each. It looks like this:
We eventually want to get rid of this file and enable the linter to infer everything it needs to know solely from the contents of
/docs/api
.So... let's document the process(es) in which each API is available within the markdown docs themselves. I've staged a few files with what seems like a reasonable way to annotate this.
Before updating every doc, I want to get feedback on the idea and implementation. What do you think, @electron/maintainers?