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

Single file vs Multiple Files vs GitHub Pages #15

Closed
michaelbprice opened this issue Sep 18, 2015 · 5 comments
Closed

Single file vs Multiple Files vs GitHub Pages #15

michaelbprice opened this issue Sep 18, 2015 · 5 comments
Assignees
Labels

Comments

@michaelbprice
Copy link
Contributor

Having the contents of the guidelines in a single Markdown file seems an odd decision. Why not split each section into a separate Markdown file? By doing so, you'd make the merging of pull requests much easier.

Also, has the Foundation considered trying to use GitHub Pages for presenting the material?

@refi64
Copy link

refi64 commented Sep 18, 2015

Completely unrelated side note: it'd be cool if you guys used a service like ReadTheDocs to render and host the markdown. It looks really cool!

@nasosi
Copy link

nasosi commented Sep 19, 2015

Reading, referring back and searching through the document is so much easier using a single page for all of it. I hope it is kept this way.

@rkwk
Copy link
Contributor

rkwk commented Sep 22, 2015

OTOH, editing a single document is far from convenient. It's not easy to locate the place where you want to make edits, and (at least on my system) GitHub is unable to show changes preview for such a huge file.

@AndrewPardoe AndrewPardoe added review and removed open labels Sep 25, 2015
@AndrewPardoe
Copy link
Contributor

For the time being we are preferring the status quo. Thank you for the suggestion!

@MaxDZ8
Copy link

MaxDZ8 commented Oct 11, 2015

Please reconsider. In-browser diff is just too convenient, especially as this keeps being a work in progress.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

8 participants
@michaelbprice @refi64 @hsutter @nasosi @rkwk @MaxDZ8 @AndrewPardoe and others