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

Documentation: UI elements #15

Open
CRImier opened this issue Oct 27, 2017 · 1 comment

Comments

Projects
None yet
1 participant
@CRImier
Copy link

commented Oct 27, 2017

UI elements are what most ZPUI apps use. They need to be properly documented, so that people know what to use in their ZPUI apps. What are the requirements?

  1. Documentation page for each UI element (under docs/ui/)
  2. Brief description (autogenerated from UI element docstrings)
  3. Usage example
  4. Links to places where the UI element is used in stock apps

Some files (like docs/ui/menu.rst) already have 1, 2 and 3 done, so they can be used as a reference for syntax necessary. Reference to all available UI elements can be found in ui/__init__.py file, and example usages of most UI elements can be found in apps/example_apps.

@CRImier

This comment has been minimized.

Copy link
Author

commented Nov 10, 2017

Instructions on helping with documentation are available here: http://zpui.readthedocs.io/en/latest/docs_development.html

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.