diff --git a/supporting-docs/_includes/footer.html b/supporting-docs/_includes/footer.html index fc43ec97..3e020c64 100644 --- a/supporting-docs/_includes/footer.html +++ b/supporting-docs/_includes/footer.html @@ -1 +1,25 @@ + + + + + + + + diff --git a/supporting-docs/_includes/head.html b/supporting-docs/_includes/head.html index ddb4d988..213e1796 100644 --- a/supporting-docs/_includes/head.html +++ b/supporting-docs/_includes/head.html @@ -12,5 +12,20 @@ + + + + + + + diff --git a/supporting-docs/_includes/nav.html b/supporting-docs/_includes/nav.html index b9f13762..b7e2d629 100644 --- a/supporting-docs/_includes/nav.html +++ b/supporting-docs/_includes/nav.html @@ -1,22 +1,33 @@ - +
+
+ + + +
+ + + +
+
+
diff --git a/supporting-docs/_layouts/default.html b/supporting-docs/_layouts/default.html index 00ea25ce..da18483e 100644 --- a/supporting-docs/_layouts/default.html +++ b/supporting-docs/_layouts/default.html @@ -4,9 +4,12 @@ {% include head.html %} - -
+ + +
{% include nav.html %} +
+
{{ content }} diff --git a/supporting-docs/_posts/2015-08-14-getting_involved.md b/supporting-docs/_posts/2015-08-14-getting_involved.md index 9a37a0ea..162ee7b8 100644 --- a/supporting-docs/_posts/2015-08-14-getting_involved.md +++ b/supporting-docs/_posts/2015-08-14-getting_involved.md @@ -33,6 +33,8 @@ You can use multiple clients with the same user, so you might want to also look ## Run a server and/or client yourself +You can clone our open source projects and run clients and servers yourself. Here is how: + ### Running your own client: You can run your own Matrix client; there are [numerous clients available](https://matrix.org/blog/try-matrix-now/). You can take Matrix.org's [reference client](https://github.com/matrix-org/matrix-angular-sdk) and use it as-is - or modify it any way you want! Since it's written in JavaScript, running a client is [really easy](https://github.com/matrix-org/matrix-angular-sdk#running)! @@ -98,6 +100,7 @@ curl -XGET "http://localhost:8008/_matrix/client/api/v1/events?access_token=YOUR "end": "s39_18_0", "start": "s39_18_0" } + 7. Even if there are no new events (as in the example above), there will be some pagination stream response keys. The client should make subsequent requests using the value of the "end" key (in this case s39_18_0) as the from query parameter e.g. ``` http://localhost:8008/_matrix/client/api/v1/events?access _token=YOUR_ACCESS_TOKEN&from=s39_18_0 @@ -105,6 +108,8 @@ http://localhost:8008/_matrix/client/api/v1/events?access _token=YOUR_ACCESS_TOK 8. This ensures that you only get new events. Now you have initial rooms and presence, and a stream of events - a good client should be able to process all these events and present them to the user. And potentially you might want to add functionality to generate events as well (such as messages from the user, for example) - again please consult the [client-server API spec](http://matrix.org/docs/howtos/client-server.html)! +| + ### Write your own server: We are still working on the server-server spec, so the best thing to do if you are interested in writing a server, is to come talk to us in [#matrix:matrix.org](https://matrix.org/beta/#/room/%23matrix:matrix.org). diff --git a/supporting-docs/_posts/2015-08-19-faq.md b/supporting-docs/_posts/2015-08-19-faq.md index 402021e1..ce58c158 100644 --- a/supporting-docs/_posts/2015-08-19-faq.md +++ b/supporting-docs/_posts/2015-08-19-faq.md @@ -19,9 +19,7 @@ Categories [Standard](#standard) -[APIs](#apis) - -[Reference Implementations](#reference-implementations) +[Implementations](#implementations) | @@ -486,7 +484,7 @@ The Apache Licence is a permissive licence. We want the Matrix protocol itself t ##### Can I write a Matrix homeserver? -Yes. Matrix is just a spec, so implementations of the spec are very welcome! It should be noted that as of October 2015 the server, changes are still being made to the spec, so if you want to write a Matrix homeserver, it is strongly recommended that you chat to the Matrix.org devs in #matrix:matrix.org first! You can also read about the [Federation API here]( https://github.com/matrix-org/matrix-doc/blob/master/specification/30_server_server_api.rst). +Yes. Matrix is just a spec, so implementations of the spec are very welcome! It should be noted that as of October 2015, changes are still being made to the spec, so if you want to write a Matrix homeserver, it is strongly recommended that you chat to the Matrix.org devs in #matrix:matrix.org first! You can also read about the [Federation API here]( https://github.com/matrix-org/matrix-doc/blob/master/specification/30_server_server_api.rst). ##### How secure is this? @@ -559,7 +557,7 @@ built by [Jenkins](http://www.matrix.org/jenkins/job/AndroidConsoleDevelop/lastB ##### Where can I find a web app? -As of Oct 2015, the best web app options are to use https://vector.im - a glossy web client written on top of matrix-react-sdk, or the original AngularJS based client at https://matrix.org/beta, which has serious performance problems and is not currently being maintained. In future a "Matrix Console" reference web app built on matrix-react-sdk will be released by matrix.org to complement the mobile apps above. +As of Oct 2015, the best web app options are to use [Vector.im](https://vector.im) - a glossy web client written on top of [matrix-react-sdk](https://github.com/matrix-org/matrix-react-sdk), or the original [AngularJS based client](https://matrix.org/beta), which has serious performance problems and is not currently being maintained. In future a "Matrix Console" reference web app built on matrix-react-sdk will be released by matrix.org to complement the mobile apps above. | diff --git a/supporting-docs/css/site_overrides.css b/supporting-docs/css/site_overrides.css index 0f9a2c80..f7640e1c 100644 --- a/supporting-docs/css/site_overrides.css +++ b/supporting-docs/css/site_overrides.css @@ -53,5 +53,10 @@ h1,h2,h3,h4,h5 { #document { margin-top: 10px; /* We want a little whitespace before the page content starts */ + width: 1080px; +} + +#wrapper { + max-width: 1080px; }