[swift-dev] Starter project: Convert release notes into something useful

[Chris Lattner]

> On Dec 5, 2015, at 1:06 PM, joe <joe at polka.cat> wrote:
> 
> Ok, that makes sense. I can start by moving it to the root as a single markdown doc and making sure it renders well on GitHub. Any strong feelings on CHANGES.md vs CHANGELOG.md?

CHANGELOG.md sounds fine to me, thank you for doing this Joe!

https://github.com/apple/swift/blob/master/CHANGELOG.md

-Chris


> 
>> On Dec 5, 2015, at 3:00 PM, Alex Chan <alex at alexwlchan.net> wrote:
>> 
>> On 5 Dec 2015, at 20:54, joe via swift-dev <swift-dev at swift.org> wrote:
>> 
>>> It was a great read, but also kind of a pain as one long doc because I preferred to read from the oldest notes to the most recent.
>> 
>> I find it useful to have change notes in a single document – it’s easy to search and find when a feature was introduced.
>> 
>>> I was thinking it might make sense to split it out into separate files based on the release dates, and move them into a subdirectory of the docs directory. For example:
>>> 
>>> docs/release-notes/2014-10-09-release-notes.md
>> 
>> Splitting them into multiple files is fine, but please have *something* that renders them as a single continuous page – substantially easier to search, and save you opening a stack of files if you want to read through multiple change sets at once.
>> 
>> Personally I’d just tidy up the existing doc and put it in at the top-level of the repo as something like CHANGELOG or CHANGES.md. (A Markdown file extension would also make it a bit prettier on GitHub.)
>> 
>> — Alex
>