78

Product support

Get help in the plugin support forum.

Categories

What does this plugin do?

Provides the ability for developers to add and maintain a ReadMe section within the admin area settings panel.
Developers can add documents to the "About & Documentation" section of the admin are settings panel as long as they have "manage readmes" access.
Each document supports a title, tags (separated by comma), and sections. Each section supports a title and content section themselves. Each section supports one layer of sub-sections, which also supports a title and content section for each. All content sections support raw HTML.
When an admin/user is viewing a ReadMe with more than one section, section titles are listed at the top of the ReadMe as an index and link to the full section below.

Why would I use this plugin?

Clients often ask for information about or documentation on usage of their application. Why not add it directly to the application to decrease their need to reach out to a developer or support staff? While we're at it, why not make it easy for developers to update the documentation as the application is revised?
Useful in helping clients with larger teams easily train and onboard new members.
Useful for smaller teams or those who don't often login to their applications remind themselves of how to use it.
Helpful in reminding developers how a client is using an application between development cycles.

Are there any requirements for this plugin?

None, other than installation and the creation of documents.

Future plans

  • Add sub-sections to document sections to provided indented sections within parent sections COMPLETE
  • Feel free to make requests by emailing them to support@albrightlabs.com
A screenshot of the App ReadMe settings pannel with documents listed.

How to add a new Document

  • From the admin area, go to Settings > About & Documentation and the "New Document" button above the list
  • Enter a title for the document
  • Enter tags for the document (separated by comma) to help with organization
  • Click the "Add new section" button
    • Enter a title for the section, if needed
    • Enter content for the section as needed
    • Click the "Add new subsection" button, if needed
  • Save the document Note: Managing Documents requires an admin to have "manage readmes" access

How to edit an existing Document

  • From the admin area, go to Settings > About & Documentation and select a document from the list
  • Click the edit button at the bottom and make the needed revisions
  • Save the document Note: Managing Documents requires an admin to have "manage readmes" access

How to delete an existing Document

  • From the admin area, go to Settings > About & Documentation and select a document from the list
  • Click the delete button at the bottom and confirm deletion of the document Note: Managing Documents requires an admin to have "manage readmes" access

Explanation of settings

  • There are no settings for this plugin
  • Found the plugin useful on 12 Jun, 2022

    I've been handling this need in a different way in the past, but on a new project I decided to try this out and it works nicely. It has what I need for the most part and that's great.

    The only negative I can think of is for those who want to stick a piece of code into the document. The Editor does have a 'code' section and it does work well, until you edit that document again. Even if you don't edit the code itself, just change say the title of the document, the code piece breaks. I've noticed it happen EVERY time I have any javascript code in there to show, and only sometimes when it is HTML or PHP code blocks.

1.0.8

Eighth version of AppReadMe

Nov 04, 2022

1.0.7

Seventh version of AppReadMe

Jun 24, 2022

1.0.6

Sixth version of AppReadMe

Jun 24, 2022

1.0.5

Fifth version of AppReadMe

Mar 28, 2022

1.0.4

Fourth version of AppReadMe

Mar 28, 2022

1.0.3

Third version of AppReadMe

Mar 28, 2022

1.0.2

Second version of AppReadMe

Mar 28, 2022

1.0.1

First version of AppReadMe

Mar 28, 2022