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

Use markdown for information and README files #197

Closed
wants to merge 1 commit into from

Conversation

The-Noah
Copy link
Contributor

@The-Noah The-Noah commented May 7, 2019

Use markdown instead of plain text files.

@allejo
Copy link
Member

allejo commented May 19, 2019

Thanks for your work on this! However, we're going to put this PR on hold for a bit while we figure some things out first.

  • Not all of the formatting and whitespace we have in our plain text files translates well to markdown
  • We want to revisit some of the content on these files. What can we get rid of or what should we rewrite.

@macsforme
Copy link
Member

I'm open to having our documentation files in markdown format, but I don't think it should be a straight-across conversion from our existing files. I would rather see the files be rewritten with the markdown format in mind, while at the same time trimming down the amount of information so it's more concise. Determining what should go into these files is something that will need to have input from the core developers, although I think the actual writing could possibly be done by other contributors once the general outline and content is determined.

@allejo
Copy link
Member

allejo commented Oct 13, 2019

Closing this PR as we'll be revisiting our READMEs and not currently looking for a 1:1 rewrite.

@allejo allejo closed this Oct 13, 2019
@The-Noah The-Noah deleted the markdown branch October 13, 2019 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants