Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Create a style guide

See original GitHub issue

Create a style guide for consistent documentation.

For example, my_function vs my_function().

Issue Analytics

State:
Created 4 years ago
Comments:5 (4 by maintainers)

Top GitHub Comments

2reactions

folsencommented, Mar 27, 2019

For function names, macros etc we should look to how Rust does it, it’s deep enough that we should have some consistency with other Rust docs, assuming people have some familiarity with that already (or will have through reading the rust book first and things like that)

0reactions

shawntabrizicommented, Mar 27, 2019

@joepetrowski on Riot, I think we agreed to use US English before 1.0 release, which prompted me to make this issue: https://github.com/paritytech/substrate/issues/1768

Top Results From Across the Web

Create a visual style guide for your brand - Canva

A comprehensive visual style guide has everything your audience needs to capture your brand, and your brand alone. Include layout references and examples...

Create a brand style guide for your business. - Adobe

A brand style guide is the rulebook for everything you create, from what fonts to use to how logo treatments work with different...

How to Create a Brand Style Guide in 5 Steps (Tips + Examples)

A style guide is simply the documentation of your brand identity, presented in a format that makes it easy to apply the identity...

How to create a brand style guide - 99Designs

How to create a brand style guide in 5 steps — · Step 1: Collect brand guide inspiration · Step 2: Define the...

Style Guide: How To Write One for Your Brand

All style guides should include an introduction. This might include a mission statement, letter from the CEO, about us page, or general overview ......