Time for Manual Guide

  • Mike

    (@wpusermg)


    7 months ago

    Hello,

    Now that the plug-in has reached certain maturity, I believe it is appropriate to have a Manual Guide dedicated to inform wider audience.

    Not all WordPress users nor many bloggers, are IT experts and there are features of the plug-in that call for easy-to-understand description and explanation.

    There really is a need for a document or a wiki that presents plugin’s functions, the way it works, and possibilities of its customisation.

    I imagine this is a huge task, but it will be very useful in making the plug-in accessible to many new users.

Viewing 4 replies - 1 through 4 (of 4 total)
  • Plugin Author Matthias Pfefferle

    (@pfefferle)

    Hey @wpusermg thanks for your feedback!

    Do you have something special in mind or a general Manual/Guide?

    If you have something specific in mind, we could maybe start with that?

    Thread Starter Mike

    (@wpusermg)

    Thank you for your prompt reaction! Please, find below some items for the possible Manual Guide that I think would be useful for novice / lay users to get to know:

    • What does the plugin do and what cannot it do? (In simple terms. This could be a short recap of what ActivityPub actually is, and what users can achieve with it, as well as what are the limitations. Possible questions:
      • Is it possible to delete / edit the ActivityPub post once it has been published by the plugin?
      • Are posts permanent, or can they have a (pre-)determined duration?
      • What happens (if anything) if the author edits the blog post once it has been published?
    • Installation and configuration (simple description of Settings, with examples).
    • A more detailed description of the Hashtags beta feature with screenshot examples.
    • Explanation of the Server section in Settings.
    • Presentation with examples of how commenting works. Is it possible to approve / edit / delete comments by the blog author (in the blog website, in the ActivityPub author profile)?
    • Can user change the avatar of the ActivityPub author profile, and how?
    • How does the ActivityPub author’s profile work? Is it possible that it observes other Fediverse profiles? Can user edit / customise this profile?

    These are some questions that lay users may have (or at least I have them ?? ). It is possible that you will find other important components for the Manual that I have not yet the idea about, eg. with regard to integrating the ActivityPub plugin with recommended plugins. I haven’t experimented with these features also for that reason that I am not sure what would be the consequences for the blog website.

    I hope this helps.

    Overall, I think that the plugin is a great idea and an interesting way to connect blogs and their authors with readers.

    • This reply was modified 7 months ago by Mike.
    Plugin Author Matthias Pfefferle

    (@pfefferle)

    Thanks for your input! Are you fine with me copying your points to GitHub, where we track our development tasks?

    Btw. maybe this also helps in the meantime: https://wpbuilds.com/demos/what-is-activitypub-and-how-does-it-work-within-wordpress-with-matthias-pfefferle/

    Thread Starter Mike

    (@wpusermg)

    Yes, of course, please share my points for further use.

    Thank you for the link to your presentation. Normally I prefer reading, but this one seems to be full of content and I will watch it with interest.

Viewing 4 replies - 1 through 4 (of 4 total)
  • The topic ‘Time for Manual Guide’ is closed to new replies.
  • In: Plugins
  • 4 replies
  • 2 participants
  • Last reply from: Mike
  • Last activity: 7 months ago
  • Status: not a support question