Update readme files for consistency/ext. #36
Conversation
Minor corrections as well as updates to the resources section
ISO8601 format added for pattern with example given
Corrected a few minor spelling/grammar errors
|
Hey @Thunkstation much appreciated PR. From a quick overview it looks fine. Will go through it again in more detail to review later! |
roboyoshi
added
enhancement
readme
README.md
Outdated
| We aim to create a unified filetree for all kinds of data. | ||
| We aim to create a unified filetree for all kinds of data, for making it easier to store, categorise and retrieve it. | ||
|
|
||
| This filetree is primarily based on the categorisation of data into directories based on the form of the data involved. For example, if a file is a .mp3 or .wav file, it would then be sorted into the audio top-level section. However, within subsections, the data is usually categorised based on category. If the previously mentioned audio file was a piece of music, it would be sorted into the artists subsection. However, if it was an audiobook, it would be sorted into the books subsection. |
There was a problem hiding this comment.
if a file is a .mp3 or .wav file, it would then be sorted into the audio top-level section
That is not the impression one should get here. This repository is aimed to create multiple examples of how one can deploy a branching based filetree for his personal data collection in a curated manner. I've purposely left that one out of the main readme so far, because it wasn't clear what this filetree would become.
There was a problem hiding this comment.
Okay, thanks for clarifying, this could definitely be expanded with a later version when multiple filetrees are available but for now I'll leave it was before. 👍
README.md
Outdated
|
|
||
| We aim to create a unified filetree for all kinds of data. | ||
| We aim to create a unified filetree for all kinds of data, for making it easier to store, categorise and retrieve it. |
There was a problem hiding this comment.
My proposal: We aim to create a unified filetree for all kinds of data, which should help in storing, categorising and retrieving.
| - https://musicbrainz.org/ - A community-maintained music metadata database. |
root/documents/README.md
Outdated
| @@ -12,7 +12,11 @@ Personal Documents like Letters, Poems, Forms, Bills, etc. | |||
|
|
|||
| ## Patterns | |||
|
|
|||
| The most common file naming scheme for documents is likely the use of the date in ISO8601 format at the start of the name (i.e YYYY-MM-DD) followed by a dash and then a useful name for the file. These names should be appropriately descriptive and formatted in an easily readable manner that allow it to be distinguished from other documents in the same subsection. | |||
There was a problem hiding this comment.
Well #10 would like to disagree. I agree that the ISO pattern is very common. I'd also like to keep it as a good example. But I'm not sure if it's the most common one. Also would love to see other patterns here. Probably part of a later commit..
There was a problem hiding this comment.
I'll change that to "one of the most common", then, generally it's what I see as the most optimal, but there's definitely other options which should be included (like #10)
root/images/README.md
Outdated
| @@ -1,6 +1,8 @@ | |||
| ## Content | |||
|
|
|||
| Images may include, but is not limited to: | |||
| The images section, most broadly, contains any kind of digital picture. | |||
There was a problem hiding this comment.
any kind of digital picture
IMO this is too restrictive / confusing. For some people (me included) pictures quickly becomes photo.. and I think that link is broken by just using the 'image' as a base and then branch out into pictures/photos/artworks/etc.
I think I had some resources on the exact definitions of picture and photo..
There was a problem hiding this comment.
Very true, "image" as a term is rather hard to define. I'll leave it as it was before until there's any better definitions available.
|
Alright, I'll try and work on some of these tomorrow and see if there's any other small additions/changes that might be good. Thanks for the feedback! |
Remove redundant paragraph, and change third paragraph to roboyoshi's suggestion.
Changed most common to one of the most common
ghost
requested a review
from
|
I think I've made all suggested changes, as well as tidying up some of the READMEs. |
|
Awesome! Thanks man |
I updated a few of the READMEs for consistency and spelling and the like, as well as fixing the README for the images folder.