Open Source version of "The Swift Programming Language"


(Hugues Bernet-Rollande) #1

Hi,

Not sure this request fit the swift evolution mailing list, but it would be
great to have an open source (GitHub) version of the programming language
guide (https://swift.org/documentation/#the-swift-programming-language) in
order to suggest edit regarding validated evolution and/or edit on the current
version.

Using branches matching evolution named could ease doc update and tag to
identify specific version evolution.

It will also facilitate any translation by homogenizing the guide structure,
like the ongoing chinese translation (https://github.com/numbbbbb/the-swift-
programming-language-in-chinese).

Markdown seem to be a good choice for the actual content, and folder structure
for the chapter.

It will also be a blast to be able to refer to some docs specific part (via
GitHub line selection feature) from others online resources (Stack Overflow,
...).

Happy to kickstart the project if Apple don't want to own it, but still think
there is a benefits for the community.

Cheers,

Hugues

Hugues BERNET-ROLLANDE

\--

hugues@xdev.fr

http://www.xdev.fr

http://www.linkedin.com/in/huguesbr


(Andrew Bennett) #2

I think this is a great idea.

I'm not sure how big a task it is to open source the current system.
Hopefully it's easy for Apple to extract the content, convert it to
markdown (if needed), and allow it to be updated from a git repo. It would
be great if the website allowed you to browse tagged release versions
(without having to go to github).

···

On Sat, Apr 16, 2016 at 1:40 AM, Hugues Bernet-Rollande via swift-evolution <swift-evolution@swift.org> wrote:

Hi,

Not sure this request fit the swift evolution mailing list, but it would
be great to have an open source (GitHub) version of the programming
language guide (
https://swift.org/documentation/#the-swift-programming-language) in order
to suggest edit regarding validated evolution and/or edit on the current
version.

Using branches matching evolution named could ease doc update and tag to
identify specific version evolution.

It will also facilitate any translation by homogenizing the guide
structure, like the ongoing chinese translation (
https://github.com/numbbbbb/the-swift-programming-language-in-chinese).

Markdown seem to be a good choice for the actual content, and folder
structure for the chapter.

It will also be a blast to be able to refer to some docs specific part
(via GitHub line selection feature) from others online resources (Stack
Overflow, ...).

Happy to kickstart the project if Apple don't want to own it, but still
think there is a benefits for the community.

Cheers,

Hugues

Hugues BERNET-ROLLANDE

--

hugues@xdev.fr

http://www.xdev.fr

http://www.linkedin.com/in/huguesbr

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution


(Hugues Bernet-Rollande) #3

Yes, switching easily between language version outside of Github would
definitely be sweet.

The docs could even be organized as one or multiple playgrounds with pages.
Allowing to see the results live and play with it.

The learning by playing with it strategy of playground seem definitely
adapted to this.

Hugues

···

On Sat, Apr 16, 2016 at 03:18 Andrew Bennett <cacoyi@gmail.com> wrote:

I think this is a great idea.

I'm not sure how big a task it is to open source the current system.
Hopefully it's easy for Apple to extract the content, convert it to
markdown (if needed), and allow it to be updated from a git repo. It would
be great if the website allowed you to browse tagged release versions
(without having to go to github).

On Sat, Apr 16, 2016 at 1:40 AM, Hugues Bernet-Rollande via > swift-evolution <swift-evolution@swift.org> wrote:

Hi,

Not sure this request fit the swift evolution mailing list, but it would
be great to have an open source (GitHub) version of the programming
language guide (
https://swift.org/documentation/#the-swift-programming-language) in
order to suggest edit regarding validated evolution and/or edit on the
current version.

Using branches matching evolution named could ease doc update and tag to
identify specific version evolution.

It will also facilitate any translation by homogenizing the guide
structure, like the ongoing chinese translation (
https://github.com/numbbbbb/the-swift-programming-language-in-chinese).

Markdown seem to be a good choice for the actual content, and folder
structure for the chapter.

It will also be a blast to be able to refer to some docs specific part
(via GitHub line selection feature) from others online resources (Stack
Overflow, ...).

Happy to kickstart the project if Apple don't want to own it, but still
think there is a benefits for the community.

Cheers,

Hugues

Hugues BERNET-ROLLANDE

--

hugues@xdev.fr

http://www.xdev.fr

http://www.linkedin.com/in/huguesbr

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution