Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add documentation links to shortcode builder #3233

Closed
mathetos opened this issue May 18, 2018 · 3 comments

Comments

Projects
None yet
3 participants
@mathetos
Copy link
Member

commented May 18, 2018

User Story

As a Give user I want to be able to learn about all features of Give by navigating the plugin. If there are additional features of a tool which need detailed explanation, I expect a link to the full documentation to be present in the plugin UI.

This problem is most evident with the Give Form Grid shortcode, but all the shortcodes in the builder would benefit from this update.

Current Behavior

Currently, there are features of the Donation Form Grid shortcode that are only discoverable via the online documentation. If I'm just using the plugin UI, specifically the shortcode builder, I would never be able to learn about these additional features.

Expected Behavior

I expect to find a link to documentation that informs me that there are additional features that I can learn about.

Possible Solution

Add logic into the shortcode builder UI that allows us to output links to documentation in a similar fashion to our current Settings API.

See Visuals below for an example

Visuals

image

Tasks

@kevinwhoffman kevinwhoffman changed the title feat(admin-form): Add documentation links to the shortcode builder feat: add documentation links to shortcode builder Mar 4, 2019

@ravinderk

This comment has been minimized.

Copy link
Collaborator

commented Mar 11, 2019

@mathetos

  1. This link is not working http://docs.givewp.com/shortcode-donation-totals
  2. Link and title missing for donor wall shortcode panel
@mathetos

This comment has been minimized.

Copy link
Member Author

commented Mar 11, 2019

Updated. Works as expected now

DevinWalker added a commit that referenced this issue Mar 12, 2019

Merge pull request #4038 from impress-org/issue/3233
feat: add documentation links to shortcode builder #3233
@mathetos

This comment has been minimized.

Copy link
Member Author

commented Mar 12, 2019

Here's the new shortlink for donor wall:
http://docs.givewp.com/shortcode-donor-wall

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.