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

Add usage guidelines and documentation #9

Open
codebytere opened this issue Jul 25, 2019 · 1 comment
Open

Add usage guidelines and documentation #9

codebytere opened this issue Jul 25, 2019 · 1 comment

Comments

@codebytere
Copy link
Member

codebytere commented Jul 25, 2019

As it stands, the requisite formatting needed to make various parts of Electron's documentation type in specific ways remains tribal. Unless you work with Electron constantly, it's not intuitive or clearly laid out that, for example, one would need to say something like:

`MyDopeParam` String - Can be `a`, `b`, or `c`.

in order to have a string param type as a string literal. We should at the very least begin to incrementally centralize this knowledge to reduce friction for those who many want to contribute to our docs or otherwise work on the project.

@MarshallOfSound
Copy link
Member

This should probably be added to https://github.com/electron/electron/blob/master/docs/styleguide.md which has a lot of info around our docs style 👍

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

No branches or pull requests

2 participants