{"action":"created","issue":{"url":"https://api.github.com/repos/Jermolene/TiddlyWiki5/issues/2912","repository_url":"https://api.github.com/repos/Jermolene/TiddlyWiki5","labels_url":"https://api.github.com/repos/Jermolene/TiddlyWiki5/issues/2912/labels{/name}","comments_url":"https://api.github.com/repos/Jermolene/TiddlyWiki5/issues/2912/comments","events_url":"https://api.github.com/repos/Jermolene/TiddlyWiki5/issues/2912/events","html_url":"https://github.com/Jermolene/TiddlyWiki5/issues/2912","id":236737931,"number":2912,"title":"Proposal for improving TW Documentation - Structure (part 1)","user":{"login":"morosanuae","id":5772514,"avatar_url":"https://avatars2.githubusercontent.com/u/5772514?v=4","gravatar_id":"","url":"https://api.github.com/users/morosanuae","html_url":"https://github.com/morosanuae","followers_url":"https://api.github.com/users/morosanuae/followers","following_url":"https://api.github.com/users/morosanuae/following{/other_user}","gists_url":"https://api.github.com/users/morosanuae/gists{/gist_id}","starred_url":"https://api.github.com/users/morosanuae/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/morosanuae/subscriptions","organizations_url":"https://api.github.com/users/morosanuae/orgs","repos_url":"https://api.github.com/users/morosanuae/repos","events_url":"https://api.github.com/users/morosanuae/events{/privacy}","received_events_url":"https://api.github.com/users/morosanuae/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":19,"created_at":"2017-06-18T18:39:54Z","updated_at":"2017-12-14T09:02:24Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"Hello,\r\n\r\nI want to propose a new structure for the TiddlyWiki documentation. In my opinion, improving the documentation in every aspect will make TW not only more useful but a lot more popular and attractive. The general idea is a more formal (standardized) and concise documentation structure. I don't mean to offend anyone but to share my experience and maybe to save other from the frustrations and obstacles I've ran into in the process of learning TW. Don't get me wrong, I'm not near an TW expert I just consider that the quality of the documentation can be raised a bit to make it look more professional.\r\n\r\n**Proposed improvements**\r\n\r\n- Less confusing and more concise chapter titles. - e.g. \"Basic Usage\" instead of \"Learning\"\r\n- Higher level of abstraction and specialization – maybe more hierarchical levels.\r\n- Chapters (and their contents) should have a more natural (logical) and progressive order.\r\n- A clear distinction between different types of documentation (e.g. guides vs. references) - guides will be mostly used by beginners and references by advanced users.\r\n- Chapters should be discrete areas of interests with a specialized role – not every user have time to read all the docs before creating the simplest thing  - get things done now, read the concept behind them later (when there's time for this). \r\n- The panel title should be \"Docs\" or \"Help\" not \"Contents\" (minor).\r\n\r\n[Demo link](http://morosanuae.tiddlyspot.com/#TiddlyWiki%20Manual)\r\n\r\n**Proposed structure** -- see demo link above for a better version\r\n\r\nGUIDES\r\n\r\n- _Welcome (a presentation similar to HelloThere)_\r\n- _How to read the documentation_\r\n- **Getting started**\r\n    - What is TiddlyWiki\r\n    - Comparison with other wikis/knowledge management tools\r\n    - Choosing an edition\r\n    -  ...\r\n- **Installation and basic configuration**\r\n    - Downloading and installing\r\n    - Setting a backup routine\r\n    - ...\r\n- **Basic usage**\r\n    - Site navigation\r\n    - Create and edit tiddlers\r\n    - Search tiddlers\r\n    -  ...\r\n- **Advanced usage**\r\n    - Creating and using macros\r\n    - Using built-in widgets\r\n    - ...\r\n- **Configuring and customize**\r\n    - Changing site title and subtitle\r\n    - Setting a favicon\r\n    -  ...\r\n- **Administration and maintenance**\r\n    - Updating TiddlyWiki\r\n    -  ...\r\n- **Extending and developing**\r\n    - Creating and using plugins\r\n    - Creating and modifying themes\r\n    - Developing modules\r\n    -  ...\r\n- **Seeking for help**\r\n    - Known problems and limitations\r\n    - Post a question on a TidldyWiki Forum\r\n    -  ...\r\n- **Helping the community**\r\n    - How to report a bug\r\n    - How to contribute a fix/improvement\r\n    - ...\r\n\r\nREFERENCES\r\n\r\n- **Concepts**\r\n- **Examples**\r\n- **Dictionary**\r\n- **TiddlyWiki Editions**\r\n- **External resources**\r\n    - **Forums**\r\n    - **Community resources**\r\n        - Plugins\r\n        - Sites\r\n- **About**\r\n\r\nThanks! "},"comment":{"url":"https://api.github.com/repos/Jermolene/TiddlyWiki5/issues/comments/351649500","html_url":"https://github.com/Jermolene/TiddlyWiki5/issues/2912#issuecomment-351649500","issue_url":"https://api.github.com/repos/Jermolene/TiddlyWiki5/issues/2912","id":351649500,"user":{"login":"morosanuae","id":5772514,"avatar_url":"https://avatars2.githubusercontent.com/u/5772514?v=4","gravatar_id":"","url":"https://api.github.com/users/morosanuae","html_url":"https://github.com/morosanuae","followers_url":"https://api.github.com/users/morosanuae/followers","following_url":"https://api.github.com/users/morosanuae/following{/other_user}","gists_url":"https://api.github.com/users/morosanuae/gists{/gist_id}","starred_url":"https://api.github.com/users/morosanuae/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/morosanuae/subscriptions","organizations_url":"https://api.github.com/users/morosanuae/orgs","repos_url":"https://api.github.com/users/morosanuae/repos","events_url":"https://api.github.com/users/morosanuae/events{/privacy}","received_events_url":"https://api.github.com/users/morosanuae/received_events","type":"User","site_admin":false},"created_at":"2017-12-14T09:02:24Z","updated_at":"2017-12-14T09:02:24Z","author_association":"CONTRIBUTOR","body":"Hi @Jermolene \r\nI don't really have a strategy for breaking things up right now, but I think it's to early to think about making PRs anyway. It's a big change and I don't want to screw it up. So, I want to be sure first that I can remap the old documentation to the new structure without major problems in my demo site. And if successful I will think about a strategy for commiting the changes in small chunks.\r\nI will come back here as soon as I finish .\r\n"}}
{"actor":{"display_login":"morosanuae"}}