Over time as the project grows, we are going to need more documentation around CI/policy. Right now we just throw both CI/design docs/policy things into ./docs. This makes the docs less organized and less discoverable. My feeling is we would want to separate the docs into:
./design - This would include design documentation and the proposals folder. This would include things like the Generics Manifesto.
./infrastructure - This would include information about the CI, policy information related to reverting llvm/clang commits
./compiler-internals - This would contain documentation of compiler internals. SIL.rst is an example of what this would contain.
Can we get swift.org hosted on GitHub Pages, and then make these documents
part of the main site? :-)
···
On Thu, Sep 22, 2016 at 2:59 PM Michael Gottesman via swift-dev < swift-dev@swift.org> wrote:
Over time as the project grows, we are going to need more documentation
around CI/policy. Right now we just throw both CI/design docs/policy things
into ./docs. This makes the docs less organized and less discoverable. My
feeling is we would want to separate the docs into:
./design - This would include design documentation and the proposals
folder. This would include things like the Generics Manifesto.
./infrastructure - This would include information about the CI, policy
information related to reverting llvm/clang commits
./compiler-internals - This would contain documentation of compiler
internals. SIL.rst is an example of what this would contain.
Can we get swift.org <http://swift.org/> hosted on GitHub Pages, and then make these documents part of the main site? :-)
That is a different topic, no? ; p.
···
On Sep 22, 2016, at 6:45 PM, Jacob Bandes-Storch <jtbandes@gmail.com> wrote:
On Thu, Sep 22, 2016 at 2:59 PM Michael Gottesman via swift-dev <swift-dev@swift.org <mailto:swift-dev@swift.org>> wrote:
Over time as the project grows, we are going to need more documentation around CI/policy. Right now we just throw both CI/design docs/policy things into ./docs. This makes the docs less organized and less discoverable. My feeling is we would want to separate the docs into:
./design - This would include design documentation and the proposals folder. This would include things like the Generics Manifesto.
./infrastructure - This would include information about the CI, policy information related to reverting llvm/clang commits
./compiler-internals - This would contain documentation of compiler internals. SIL.rst is an example of what this would contain.