README.md gallery of codes revamp

[hugolpz]

Following #30 API documentation revamp (JSDoc migration) , the README.md must be rewritten. (I propose to lead this while @kanasimi works on wikiapi.js JSDoc3 comments).

Readme.md code gallery :

• Code gallery clean up / improvements
• Add pointer to new JSDoc sections
• Create demo starter bot with basic actions #35: Identify bot setup steps ; Account creation ; User-right requests ; Tests ; Bot request.
• Reduce code gallery to essential parts

[hugolpz]

@kanasimi ... I looked for a way to both learn and help a bit.

Current

The current README.md which was gradually expanded seemed messy to me. So I reorganized the README.md's examples, see #34 . There are still some glinch, but I expect them to be fixed/removed before anyone see them.

Changes

On changes ...

• removed duplications : wiki.login, async
• Create group descriptions
• Cleaner example descriptions
• Accessible in-code comments when needed

The main point was to group related functions together :

• READ
• EDIT <------ has too many codes
• MULTI-EDIT <---- together with 3 ways to create lists ; )
• MOVE
• PARSE <------ a bit unclear
• MONITOR
• FILES
• WIKIDATA

Having clarity on these may help you in your current and long term vision hopefully. 👨🏼‍🎤

Future #30 #35

I'am not sure this README.md gallery of codes is still needed since:

• API documentation revamp (JSDoc migration) #30: The JSdoc3 coming with examples.
• Create demo starter bot with basic actions #35: I started a demo bot repository which will contain convenient basic codes, better organized and ready to fire.

Today

• Reorganisation of code gallery #34: Today, I suggest to accept PR Reorganisation of code gallery #34 . Some improvement are there, mainly a well structured gallery.

Coming days and shifting role

The code gallery's role can be reduced to a simple appetizer, an hint. It should quickly redirect to the JSdoc3 webpage (and the future demo bot repository). The project also gain from less code to maintain 😎 ...

What to do with this gallery of code :

• most significant and illustrative code parts could be kept in a reduced README.md gallery, to attract new users. Maybe:
  • Login
  • Edit members of a category
  • Move page
  • read wikidata.
• some parts could be moved into relevant wikiapi.js @example sections
• some/most parts which are already in wikiapi.js @examples or duplications could be simply deleted.

Maintenance efforts should be shifted toward a single source of truth : JSdoc3. (And demo bot 🤖 ).

[hugolpz]

@kanasimi : I think i finished my sprint on this readme code gallery for now.

It's now up to you to balance it with your wikiapi.js/JSdoc push and trim the code gallery as needed. 👍🏼

[hugolpz]

2021 continuation

• READ
• EDIT <------ 2020: too many codes
• MULTI-EDIT <---- 2020: together with 3 ways to create lists ; )
• MOVE
• PARSE <------ 2020: a bit unclear
• MONITOR
• FILES <------ 2021: miss download
• WIKIDATA <------ 2021: to review