GK Steemit Info Wordpress Plugin 0.8.0: Documentation Updates

in #utopian-io6 years ago

Repository

https://github.com/mcfarhat/gk-steemit-info

Introduction

Following the release of both versions 0.7.0 and 0.8.0 of our GK Steemit Info wordpress plugin, a documentation update was more than needed in light of the additional changes and major functionality added as a result those last two updates.

Quick Recap

GK Steemit Info wordpress plugin serves the purpose to provide wordpress bloggers to easily integrate and render information related to steem(it) on their own personal blog. This provides a great flexibility but also utmost promotional purposes for the steem blockchain. The plugin allows a multitude of widgets/shortcodes including but not limited to steem info, user info, steemit posts, voted posts, posts by tag, as well as the capability of user account creation via delegation.

Documentation Updates

As highlighted in the introduction, versions 0.7.0 and 0.8.0 are covered in this documentation update, and essentially focus on the creation of a major component, being the tag filtered voted posts widgets and shortcodes versions, along with several other modifications and updates, as follows:

  • Creation of a new widget and relevant shortcode titled Steemit Tag Filtered Voted Posts to allow proper curation effort and general display of steemit posts on any wordpress site whether in a widget or on a page/post with several filtering options.
  • Display enhancements for single post view across all the plugin's widgets/shortcodes
  • Better code refactoring via completely moving stylesheet code into a separate plugin specific CSS file.
  • Minor bug fix for older shortcodes

Links

The plugin's code and documentation are all accessible via the plugin's official Github repository.
The documentation under the readme.md file has been updated and is publicly available.

Partial screenshot of some of the documentation updates. For full changes, check out the commit link in following section
image.png

GitHub Proof of Authorship

All work has been implemented using my github account here
Recent commit link pertaining to this latest update/commit of the official documentation available here

Thank you for reading through.
@mcfarhat

Sort:  

I will advise you to turn the documentation of this project attractive you can use auto documentator or you can use plugin for documentation like Mkdocs.

It will make the documentation look more appealing for contributors and users of this plugin.

I will show you some examples which used Mkdocs -

There are many themes available you can try out.

I will also advise you to put more work into one contribution which increases the quality of your contribution.

Thank you!

Your contribution has been evaluated according to Utopian rules and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post,Click here


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

Hey @ms10398
Here's a tip for your valuable feedback! @Utopian-io loves and incentivises informative comments.

Contributing on Utopian
Learn how to contribute on our website.

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!

Thanks for the update.
Upvoted and has been added to the latest MAP Upvotes post.

Hey @mcfarhat
Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!

Contributing on Utopian
Learn how to contribute on our website or by watching this tutorial on Youtube.

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!

Dear @mcfarhat. I've noticed you still have free slots to approve witnesses. We have started a new steem witness and are trying to represent steem with pride and advance its cause on several dimensions.

One thing that might be of interest to you, as Utopian, is that we are organizing next Wednesday (may 23rd) the First Steem Meetup in Luxembourg where we'll have @roxane as special guest and she'll be presenting Utopian.io to the audience

Our detailed witness application is here.

Would you maybe consider approving it as well?

Good post. Thankyou @mcfarhat and sukses always. By me @nyakti

Congratulations @mcfarhat! You have completed some achievement on Steemit and have been rewarded with new badge(s) :

Award for the number of upvotes

Click on any badge to view your own Board of Honor on SteemitBoard.
For more information about SteemitBoard, click here

If you no longer want to receive notifications, reply to this comment with the word STOP

Do you like SteemitBoard's project? Vote for its witness and get one more award!

Thank you for these informative updates @mcfarhat.

Coin Marketplace

STEEM 0.30
TRX 0.12
JST 0.033
BTC 64534.17
ETH 3150.15
USDT 1.00
SBD 4.01