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

Consider unifying some/many task-specific files #9

Closed
cbockman opened this issue Jun 24, 2018 · 6 comments
Closed

Consider unifying some/many task-specific files #9

cbockman opened this issue Jun 24, 2018 · 6 comments

Comments

@cbockman
Copy link
Contributor

In response to #6:

For me: Having a single README (or, potentially, at least a smaller number than we have now) makes it easier (for me) to skim through all numbers, papers, results, etc.

Request to open for discussion:

  • consider re-unifying the many task-specific files back into a single README.
  • Or, possibly, into some smaller number of grouped, related items. (Don't know a good grouping offhand, but could investigate.)

Opening this for discussion at request of @sebastianruder .... polling community to see what would be easiest.

I will concede that in the long run, either way, there may be a pressure to split things back up (as tasks & papers accumulate), but my (personal!) leaning would be to keep things merged, for now, and then split things back up at some future point.

@nth-attempt
Copy link

nth-attempt commented Jun 25, 2018

I would prefer the merged version as well. As you said it is easier to browse through.

Frequency of contributing is much smaller than reading through.

@sebastianruder
Copy link
Owner

Cool. Any more opinions?

@sebastianruder
Copy link
Owner

Given the pace that new tasks and new results are being added (which is awesome!), I'm a bit more concerned now that a single page will both become unwieldy and at some point also less clear pretty quickly. In light of that, I think I'm in favour of the current format.

@cbockman
Copy link
Contributor Author

Perhaps a twitter poll? My one last pitch here. IMO, as-is, I'll have a hard time coming back and re-visiting this resource.

There are many other ways to alleviate this, to provide better searchability etc., but it is hard to beat single file plus grep (ctrl+f), without a bunch of work.

I'm not entirely unique, but perhaps we are a minority. :)

Last alternate, somewhat simple thought--

  • Multiple docs (for editing, if you prefer)
  • auto-generated single doc (for viewing)

@sebastianruder
Copy link
Owner

Cool, yeah, I just wanted to voice my current sentiment. I can definitely still be swayed. :)
A Twitter poll seems like a good way to get some more feedback. Let's leave this open and see if more people join the discussion.
Could you elaborate a bit on your two alternate ideas? How would you propose to keep multiple docs for editing? What's a good way to auto-generate a single doc?

@cbockman
Copy link
Contributor Author

Sorry, that was clearly confusing! Those were a single idea:

  • Leave your separate files
  • Have a separate script that automatically periodically concats these separate files into a master SINGLE_FILE.md

Repository owner deleted a comment Jun 30, 2018
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

3 participants