{"action":"created","issue":{"url":"https://api.github.com/repos/LingDong-/wenyan-lang/issues/516","repository_url":"https://api.github.com/repos/LingDong-/wenyan-lang","labels_url":"https://api.github.com/repos/LingDong-/wenyan-lang/issues/516/labels{/name}","comments_url":"https://api.github.com/repos/LingDong-/wenyan-lang/issues/516/comments","events_url":"https://api.github.com/repos/LingDong-/wenyan-lang/issues/516/events","html_url":"https://github.com/LingDong-/wenyan-lang/issues/516","id":548184496,"node_id":"MDU6SXNzdWU1NDgxODQ0OTY=","number":516,"title":"Docs site","user":{"login":"antfu","id":11247099,"node_id":"MDQ6VXNlcjExMjQ3MDk5","avatar_url":"https://avatars2.githubusercontent.com/u/11247099?v=4","gravatar_id":"","url":"https://api.github.com/users/antfu","html_url":"https://github.com/antfu","followers_url":"https://api.github.com/users/antfu/followers","following_url":"https://api.github.com/users/antfu/following{/other_user}","gists_url":"https://api.github.com/users/antfu/gists{/gist_id}","starred_url":"https://api.github.com/users/antfu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/antfu/subscriptions","organizations_url":"https://api.github.com/users/antfu/orgs","repos_url":"https://api.github.com/users/antfu/repos","events_url":"https://api.github.com/users/antfu/events{/privacy}","received_events_url":"https://api.github.com/users/antfu/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2020-01-10T16:51:51Z","updated_at":"2020-01-10T18:23:25Z","closed_at":null,"author_association":"COLLABORATOR","body":"First, congrats for the new IDE 🎉 It looks awesome!\r\n\r\nI am working on a doc website for wenyan in order to provide better documentation and tutorials for users to reference.\r\n\r\nYou can check it out by https://wenyan-docs.netlify.com/ (very early stage, just simply vendored the docs from this project, and the source is in a private repo (yet))\r\n\r\n## Things I may need help\r\n- Tell me what you think of this idea! If you like it, I'll move it to `wenyan-lang` org when it's ready\r\n- **SVG version of the Logo** - the logo provided in the repo is a little too low-res. May need a better logo for website/tools/avatar/3rd-party references. (The current logo in the docs is a mimicry I made for wenyan-lang-vscode, and I can not found the font exact matched to the given one)\r\n- Maybe we need some brand colors as well.\r\n\r\n## Things to be done for the docs\r\n- Syntax highlight for wenyan block\r\n- A REPL component for interactive demos\r\n- Font & style adjust\r\n- Fulfill the docs\r\n- Tutorials"},"comment":{"url":"https://api.github.com/repos/LingDong-/wenyan-lang/issues/comments/573150137","html_url":"https://github.com/LingDong-/wenyan-lang/issues/516#issuecomment-573150137","issue_url":"https://api.github.com/repos/LingDong-/wenyan-lang/issues/516","id":573150137,"node_id":"MDEyOklzc3VlQ29tbWVudDU3MzE1MDEzNw==","user":{"login":"antfu","id":11247099,"node_id":"MDQ6VXNlcjExMjQ3MDk5","avatar_url":"https://avatars2.githubusercontent.com/u/11247099?v=4","gravatar_id":"","url":"https://api.github.com/users/antfu","html_url":"https://github.com/antfu","followers_url":"https://api.github.com/users/antfu/followers","following_url":"https://api.github.com/users/antfu/following{/other_user}","gists_url":"https://api.github.com/users/antfu/gists{/gist_id}","starred_url":"https://api.github.com/users/antfu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/antfu/subscriptions","organizations_url":"https://api.github.com/users/antfu/orgs","repos_url":"https://api.github.com/users/antfu/repos","events_url":"https://api.github.com/users/antfu/events{/privacy}","received_events_url":"https://api.github.com/users/antfu/received_events","type":"User","site_admin":false},"created_at":"2020-01-10T18:23:25Z","updated_at":"2020-01-10T18:23:25Z","author_association":"COLLABORATOR","body":"> maybe it could be of an online-book-like form. It will be more an official introduction/handbook to the language, focusing more on the syntax/programming side. \r\n\r\nThe book idea sounds great! (and looking forward to the classical Chinese version 😄). It's definitely great to have a formal documents for a language.\r\n\r\n> We can keep the install instructions & links on the Github Repo (or Wiki).\r\n\r\nHow about we keep both the `book` and the `docs` site? The main reason I am trying to make this doc is to make newcomers get started more quickly. I think the current \"linear\" style of the readme is not intuitive to know where to start. Jumping documents in Github may be easier to got lost as well.\r\n\r\nThe doc is built by [vuepress](https://github.com/vuejs/vuepress). There are some benefits I can think about.\r\n- Search for documents\r\n- Multi-languages support, it will be a dropdown menu on the rightmost nav bar to select the language. And it well be more manageable.\r\n- Easier to navigate.\r\n- Custom syntax highlight for wenyan.\r\n- Interactive examples - just as you did for the `site`\r\n- Can be separated from the main repo\r\n- Easier for people to contribute.\r\n\r\nI think we can keep the doc site for `Beginner Guides` `Tutorials` `Installations` and `Tools index` (or maybe `awesome-wenyan` as well). While the `book` focusing on the formal language/syntax details.\r\n\r\n> Book of Shaders\r\n\r\nLooks awesome! Thanks for sharing!\r\n\r\n> I think they have many elements I enjoy (explanation, interactive example, chapters, etc. \r\n\r\nWe can have them too! I think we should rewrite the docs for guides for the better reading.\r\n\r\n> And I can work on some page layout/design to make the site look unique and reminiscent of classical motifs.\r\n\r\nOf course. Will definitely do that!\r\n\r\n----\r\n\r\nLet me know what you think about it. Thanks!\r\n\r\n"}}
{"actor":{"display_login":"antfu"}}