Skip to content

Commit fcd1a69

Browse files
committed
make docs official
1 parent 2c93322 commit fcd1a69

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# SuperCollider documentation
22

3-
The aim of this repository is to provide a transparent and semi-official way of deploying the documentation of SuperCollider into the web.
3+
This repository builds the official documentation of SuperCollider on the web which is located at [docs.supercollider.online](https://docs.supercollider.online).
4+
It is built and deployed every week based on the source files of the latest major version of SuperCollider.
45

5-
* [x] Changes source code links to the hosted files on GitHub
6-
* [x] Stays automatically up-to-date and makes the build process transparent
7-
* [x] Allows for CSS patches which creates a better UX on bigger screens (see `custom.css`)
6+
The following enhancements and adjustments have been made to the documentation:
87

9-
Currently this only includes the documentation of the sclang core and not any Extensions.
10-
Feel free to create a Pull Request to include any
8+
* [x] Links to source files are heading to the source files on GitHub instead of a local copy.
9+
* [x] A CSS patch that limits the screen-width which improves readability on wider screens (see `custom.css`)
10+
11+
The documentation is limited to a vanilla installation of SuperCollider, i.e. without any plugins or Quarks.
12+
The documentation for each Quark can be found at [baryon.supercollider.online](https://baryon.supercollider.online).
13+
14+
This repository contains all the necessary build steps for the documentation and uses [GitHub Pages](https://pages.github.com/) for hosting of the static HTML files.
15+
This could be replaced with any other static file hosting mechanism in the future.
16+
17+
> In case of a new major release update the branch in `Dockerfile`
1118
1219
## Build
1320

@@ -32,7 +39,7 @@ docker run -v ${PWD}/build:/root/scdocs scdocs /root/build_docs.sh
3239
3340
To access the docs in a webserver way it is possible to use a lightweight development web server via Python
3441

35-
```
42+
```shell
3643
cd build && python3 -m http.server
3744
```
3845

0 commit comments

Comments
 (0)