Expand instructions document

[brentonpeterson]

Mainly a bit on "common questions" and troubleshooting, such as how long it takes for new followers to appear, what the account names should look like.

[trutzig89182]

Copying this from #3 where we started to discuss this some days ago.

• Upload instruction images seperately to "resources folder"
• Create instructions.html
• Describe what has to be done
• Add alt text for better access
• update reference in index.html

[trutzig89182]

Hey @stark1tty, perhaps you are interested in contributing to this issue? I think it would be good to have a better instruction document, but I don’t really get around it.

[stark1tty]

Happy to later this week! Got a work trip until Weds, but I will add it to my list. :)

[stark1tty]

Any updates on where you left off? I am going to take a look next week. I have a report due tomorrow, then I will thankfully not need to play so much catch-up. :)

[trutzig89182]

Hey @stark1tty, I have not been working on this a lot. Basically, I created a instructions.html stub where you could add instructions and perhaps images. Once this is ready, we can just switch the link in the main page to it instead of the pdf. I suggest to inherit the formatting from the main page, so this does also not require to much technical work.

[brentonpeterson]

hey all, sorry, I got busy with work and sort of abandoned this. @stark1tty have you worked on this at all?

I have some time to either:
A) help
B) put together something and see if any of you have suggestions/additions

The only thing I've done so far is take screenshots of the process. The current instructions pdf show the process on the web gui, but it's different on the mastodon and tusky Android apps, so I thought we should document the process across a few common apps (someone on iOS could help here).

[trutzig89182]

Hey Brenton,

I did not work on this further, as I focused on including keywords and language to keep the list useful with now over 400 entries in the sociologists’ list. My impression was, that it would make sense to use the web gui for this process anyway, but perhaps I am just a bit oldschool with these things.

We could just start with the description of how to do it in the browser gui and then add further instructions and a TOC later?

I also only have access to the android apps, though.

@brentonpeterson @stark1tty

[trutzig89182]

I have created a branch to work on this https://github.com/trutzig89182/Mastodon-Sociologists/tree/wip-008-better-instructions

There is already the instructions.html that we can work on and then just add the link to it in the index.html.

The general workflow is: work on the feature in the wip branch, once it is done, push it to the dev branch, and from there it can be pushed to main (with other changes, if for instance I get the "sort by name" option to work in the meantime). (wip -> dev -> main)

This process is intended to make checking for conflicts easier and to keep the amount of commits to main low, so that people forking it don’t get confused and can identify changes more easily.

[stark1tty]

Apologies, I have not gotten to this yet. I have a report and a chapter due in the next few weeks and I have been a bit overwhelmed. I am quite behind at the moment. I am hoping to hand off at least one of these tomorrow and have more free time next week.