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

Metadata is hard to read #2

Open
mkeara opened this issue Dec 18, 2019 · 0 comments
Open

Metadata is hard to read #2

mkeara opened this issue Dec 18, 2019 · 0 comments

Comments

@mkeara
Copy link

mkeara commented Dec 18, 2019

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:

  1. Are the metadata chunks intended for human reader consumption or some other system requirement?
  2. If intended for humans, would it be ok to define these as code blocks to preserve the indentation?
  3. Would it be useful to add /* */ around the sections to indicate they are commented (like a doc block)?
  4. 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?
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

1 participant