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

Infra: Create a Markdown style guide #11

Open
sleevi opened this issue Jan 29, 2021 · 1 comment
Open

Infra: Create a Markdown style guide #11

sleevi opened this issue Jan 29, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@sleevi
Copy link
Contributor

sleevi commented Jan 29, 2021

To help assist members and CWGs, we should look at documenting good practices for writing Forum Guidelines in Markdown.

The most obvious issue that would benefit from consistency is the numbering style of list items, but other elements, such as section headers, using code format for ASN.1 notation, and how to express tables in a useful way would benefit from documentation, especially for members new to Markdown, but possibly familiar with our Wiki syntax or other such syntaxes.

@srdavidson
Copy link

As we now have multiple standards, edited by different people over varying spans, a basic CABF style guide would help us both in good markdown practices but also in maintaining consistency of terminology. Examples might include to harmonise the use of MUST vs SHALL, document the appropriate capitalisation of Definitions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Infrastructure
  
Awaiting triage
Development

No branches or pull requests

2 participants