Help wanted writing documentation

[thomas694]

Who has (technical) writing skills and wants to write user documentation and tutorials for the TumblThree application?

The goal would be to have an user documentation for explaining the functionality of the TumblThree application, as well as a website that attracts more people to TumblThree.

Subtasks for a start would be something like:

• gather and combine the information from the different repositories, wikis and old website and update it
• evaluate whether GitHub Pages are enough for the task or an additional tool like Wyam is necessary or provides benefits
• evaluate if its possible to create eg. a PDF out of the Markdown code or an online-only version should be enough
• write the user documentation and web site content
• the source of the documentation and/or web site shall be easily editable and manageable through a repository

Subtasks are subject to slight changes as the evaluation progresses.

Do you like to support us and make a contribution? Your help is greatly appreciated.

[ParisaTork]

It looks like you're good for documentation but I'm happy to help if there's still work that needs doing

[thomas694]

First of all thanks for your willingness to support. Help is always appreciated.

Maybe you can give us a short summary of your first impressions of this project page, what looks "wrong", obviously is missing, etc. You can also send it by email, should you prefer.

Currently we are evaluating if it makes sense to add a new forum (GitHub Discussions). If yes, it would be necessary to categorize and move "articles" from the Issues section to the new one.

Besides that, there's still work left going through the issues (maybe also from the archived repository) and look which contain documentation or question & answers, and somehow present them in the Wiki section.

Feel free to suggest any ideas you might have.

[thomas694]

Haven't heard from you since then. Are you still in?

..., it would be necessary to categorize and move "articles" from the Issues section to the new one.

Would you like to do this task?

[ParisaTork]

Hi - sorry for being late to respond, was on the job hunt / settling in!

First impressions:
A few things stuck out to me:

• The features list, though wonderful, is quite long - it would also be good to have some visual demonstrations of what the app does i.e. through GIFs
• I'd add the screenshot to the beginning and remove the 'screenshot' title
• Getting started: I'd add a video or a few images in lieu of text
• 'Login／Authenticate does not work' is great
• Good code snippets in the 'how to open a PR' section

[ParisaTork]

I'd certainly trial GitHub Discussions with a few issues - see what the response level is like and then gauge conclusions as to keep it from there.

[thomas694]

Thanks for your first impressions, we'll incorporate your ideas.

As you may have already seen, we've enabled the Discussions and Emmanuel was so kind to convert some of the issues. Maybe some adjustments need to be made, but already it doesn't look empty anymore. Now we have to see.

May you do well! Maybe you can support us elsewhere, when you are not so busy.