This repository contains the source for the Scala documentation website, as well as the source for "Scala Improvement Process" (SIP) documents.
To build and view the site locally:
gem install bundler
bundle install
bundle exec jekyll serve -I
For more details, read on.
To build and view site with docker:
docker-compose up
It will incrementally build and serve site at http://localhost:4000
Please have a look at https://docs.scala-lang.org/contribute.html before making a contribution. This document gives an overview of the type of documentation contained within the Scala Documentation repository and the repository's structure.
Small changes, or corrected typos will generally be pulled in right away. Large changes, like the addition of new documents, or the rewriting of existing documents will be thoroughly reviewed-- please keep in mind that, generally, new documents must be very well-polished, complete, and maintained in order to be accepted.
