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

Improve docs for each widget #847

Closed
aschweigert opened this issue Aug 17, 2015 · 5 comments
Closed

Improve docs for each widget #847

aschweigert opened this issue Aug 17, 2015 · 5 comments
Assignees
Labels
priority: high Either blocks work on a priority-normal task or a solution here informs other work. status: needs docs type: improvement

Comments

@aschweigert
Copy link

http://largo.readthedocs.org/users/sidebarswidgets.html is pretty barebones, we should have a better reference for each widget re: what it does, the options available, recommendations for use, etc.

@aschweigert aschweigert added this to the 0.5.3 - Widgets milestone Aug 17, 2015
@aschweigert aschweigert added the priority: high Either blocks work on a priority-normal task or a solution here informs other work. label Aug 21, 2015
@aschweigert aschweigert self-assigned this Aug 21, 2015
@benlk
Copy link
Collaborator

benlk commented Sep 2, 2015

Should this have a separate file in the docs for each widget? That way there would be plenty of space for screenshots showing the different options for each widget.

@aschweigert
Copy link
Author

aschweigert commented Mar 17, 2016

still needed (copied from #1160):

  • if we add the link roundups widget we should also add the saved links widget (added by the same plugin
  • this should actually probably be a separate section including widgets added by commonly used plugins (link roundups, dfp, analytic bridge, etc.)
  • we need to add a section re: the default WP widgets that we de-register (and maybe explain why), the list can be found in inc/widgets.php
  • the taxonomy list widget will need updated docs when Revisit the Taxonomy List widget #1171 is merged

@aschweigert
Copy link
Author

I'm also a +1 on eventually breaking these up into separate pages per widget

@aschweigert
Copy link
Author

I agree on separate pages, and on adding screenshots. I thought maybe we update the one page first, then iterate on this. I haven't added images to .rst files, but it looks like getting everything right might be a bit of a process.

[--- Commented from Asana.com
#commenter Jack Brighton
---[aa]

@jackbrighton
Copy link

The section http://largo.readthedocs.io/users/sidebarswidgets.html#largo-recent-posts needs revision again since the update to the widget changed a few things in the settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: high Either blocks work on a priority-normal task or a solution here informs other work. status: needs docs type: improvement
Projects
None yet
Development

No branches or pull requests

4 participants