docs-parser icon indicating copy to clipboard operation
docs-parser copied to clipboard

Add usage guidelines and documentation

Open codebytere opened this issue 6 years ago • 1 comments

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.

codebytere avatar Jul 25 '19 22:07 codebytere

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 👍

MarshallOfSound avatar Jul 26 '19 00:07 MarshallOfSound