{"action":"created","issue":{"url":"https://api.github.com/repos/LearnBoost/stylus/issues/1242","labels_url":"https://api.github.com/repos/LearnBoost/stylus/issues/1242/labels{/name}","comments_url":"https://api.github.com/repos/LearnBoost/stylus/issues/1242/comments","events_url":"https://api.github.com/repos/LearnBoost/stylus/issues/1242/events","html_url":"https://github.com/LearnBoost/stylus/issues/1242","id":23228764,"number":1242,"title":"New site for Stylus","user":{"login":"kizu","id":177485,"avatar_url":"https://avatars.githubusercontent.com/u/177485?v=3","gravatar_id":"","url":"https://api.github.com/users/kizu","html_url":"https://github.com/kizu","followers_url":"https://api.github.com/users/kizu/followers","following_url":"https://api.github.com/users/kizu/following{/other_user}","gists_url":"https://api.github.com/users/kizu/gists{/gist_id}","starred_url":"https://api.github.com/users/kizu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kizu/subscriptions","organizations_url":"https://api.github.com/users/kizu/orgs","repos_url":"https://api.github.com/users/kizu/repos","events_url":"https://api.github.com/users/kizu/events{/privacy}","received_events_url":"https://api.github.com/users/kizu/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/LearnBoost/stylus/labels/s:%20Docs","name":"s: Docs","color":"DDDDDD"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":26,"created_at":"2013-11-25T08:55:44Z","updated_at":"2015-02-14T14:13:14Z","closed_at":null,"body":"I'm here to say, that I'm working on the new Stylus site.\r\n\r\nRight now the engine is almost complete (**upd: it is complete and is in production**), when all the basic stuff would be there, I'll move the site to the engine, without touching the existent content and without changing the styles. Then we could begin the rewriting of the existent docs, adding new examples, redesigning everything etc. — the new engine would make it easy and fun.\r\n\r\nDeadline for the first sneak-peak for the site is somewhere around the first two weeks of January (somewhat far, I know, but realistic)\r\n\r\nBelow is my vision of the site, feel free to discuss anything.\r\n\r\n## Engine\r\n\r\nRight now the site is hosted on GitHub pages — and that's ok. But it is not using any of the nice Jekyll features — everything is built locally and then just pushed to the gh-pages branch.\r\n\r\nI'm working on a proper Jekyll-based engine for blogs and sites that could be used for Stylus' site perfectly.\r\n\r\nIt would able us automate a lot of things for the docs and make them usable, maintainable and just awesome.\r\n\r\n## The data\r\n\r\nRight now the docs are in a strange state. Most of them are stored in the `gh-pages` branch, some of them are duplicated in the `docs/` of the `master` branch, and they're not synced. People don't know where to commit the changes and how to build them. We need to have only one place where the docs are stored and it should be the main repo, so people could update the docs when they update the code in one PR.\r\n\r\nSo, as the docs would be stored in `master` branch, how would they go to the `gh-pages`? Using git submodules. GitHub Pages support them, so we could just write the docs near the code and them attach them to the submodule. This way `gh-pages` won't contain any docs and there would be only an engine.\r\n\r\n## The docs themselves\r\n\r\nMost of the docs are somewhat generated from the jsdoc, then there were a lot of changes right in the generated files, thn some docs are hand-written from scratch etc.\r\n\r\nI'm against using jsdoc and other autogenerated ways for main docs, as it limits what we can do in them and makes it hard to find where to fix things.\r\n\r\nSo, there should be only hand-written docs, containing useful up-to-date examples, placed in the `.md` in the `master` branch.\r\n\r\n## Examples\r\n\r\n@panya recently updated the client version of Stylus — http://learnboost.github.io/stylus/try.html\r\n\r\nThis means we have an ability to use it everywhere in the docs, enhancing every and each example.\r\n\r\nOf course, that would be done in a lazy way, so even without the script you could see the `before`/`after` code, but when the script would be loaded, you could edit the `before` part to see how the `after` changes.\r\n\r\n## Design and styles\r\n\r\nThat is not the most important thing, but it would be nice to have a new simple, but nice design for the site, and there should be some nice Stylus code inside. While I'm thinking on doing everything by myself there, you could contribute to it when I'll ship the first initial version.\r\n\r\n## What else?\r\n\r\nFeel free to tell what you miss in the Stylus' docs and site!\r\n"},"comment":{"url":"https://api.github.com/repos/LearnBoost/stylus/issues/comments/74376497","html_url":"https://github.com/LearnBoost/stylus/issues/1242#issuecomment-74376497","issue_url":"https://api.github.com/repos/LearnBoost/stylus/issues/1242","id":74376497,"user":{"login":"corysimmons","id":224636,"avatar_url":"https://avatars.githubusercontent.com/u/224636?v=3","gravatar_id":"","url":"https://api.github.com/users/corysimmons","html_url":"https://github.com/corysimmons","followers_url":"https://api.github.com/users/corysimmons/followers","following_url":"https://api.github.com/users/corysimmons/following{/other_user}","gists_url":"https://api.github.com/users/corysimmons/gists{/gist_id}","starred_url":"https://api.github.com/users/corysimmons/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/corysimmons/subscriptions","organizations_url":"https://api.github.com/users/corysimmons/orgs","repos_url":"https://api.github.com/users/corysimmons/repos","events_url":"https://api.github.com/users/corysimmons/events{/privacy}","received_events_url":"https://api.github.com/users/corysimmons/received_events","type":"User","site_admin":false},"created_at":"2015-02-14T14:13:14Z","updated_at":"2015-02-14T14:13:14Z","body":"@kizu Sure thing on the LearnBoost logo. Can I get an SVG or a hi-res raster of their logo?"}}