You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In looking at making improvements to the docs, I'm wondering what the intent is for the metadata at the top of each md file. Currently this is a set of line items in the md files that render as a single line and are difficult to parse for the human reader. This raises a few questions in the context of editing these docs:
Are the metadata chunks intended for human reader consumption or some other system requirement?
If intended for humans, would it be ok to define these as code blocks to preserve the indentation?
Would it be useful to add /* */ around the sections to indicate they are commented (like a doc block)?
If these sections are not rendered as code blocks then the indentation become difficult. It looks like the only way to do that is to convert the section to lists. That might be harder to read and potentially visually distracting. Is there another way to preserve the indentation?
The text was updated successfully, but these errors were encountered:
In looking at making improvements to the docs, I'm wondering what the intent is for the metadata at the top of each md file. Currently this is a set of line items in the md files that render as a single line and are difficult to parse for the human reader. This raises a few questions in the context of editing these docs:
/* */
around the sections to indicate they are commented (like a doc block)?The text was updated successfully, but these errors were encountered: