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

.md or .rst #4

Open
lheagy opened this issue Apr 19, 2021 · 7 comments
Open

.md or .rst #4

lheagy opened this issue Apr 19, 2021 · 7 comments

Comments

@lheagy
Copy link
Member

lheagy commented Apr 19, 2021

for the docs in this repo, it would be good to choose either .md or .rst and be consistent.

My vote is for .md as these docs are quite simple and markdown is more widely used than .rst, and we can copy from GH issues, etc that have markdown styling.

  • vote with 👍 for .md
  • vote with 👎 for .rst
@lheagy
Copy link
Member Author

lheagy commented Jun 30, 2021

I am going to suggest we use .md to have things nicely rendered on github. if there are no objections by the end of the week, I will assume folks are okay with this :)

@prisae
Copy link
Member

prisae commented Jun 30, 2021

I say you phrased that survey very biased by giving one a 👍 and one a 👎 ... ;-)

@lheagy
Copy link
Member Author

lheagy commented Jun 30, 2021

there is only a small choice of emojis reactions here ;-)

@prisae
Copy link
Member

prisae commented Jun 30, 2021

I am fine with either. But I do think that with .md you sometimes reach the limits soon...

However, if it is without any sphinx then it might actually be more than enough.

@lheagy
Copy link
Member Author

lheagy commented Jun 30, 2021

Yeah, I don't have strong opinions either way, but I think this repo should stay pretty simple in terms of what we need/want to include. The website-building should be confined to the individual repositories docs + the simpeg website itself

@prisae
Copy link
Member

prisae commented Jul 7, 2021

I just changed form 👎 to 👍 - given your explanation that it is only for here, the community repo.

@lheagy
Copy link
Member Author

lheagy commented Jul 7, 2021

Thanks @prisae! Since only you and I seem to have opinions on this, I will call that consensus :)

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

2 participants