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

Docs: GUI documentation consistency #347

Open
jonnystening opened this issue Jul 11, 2017 · 1 comment
Open

Docs: GUI documentation consistency #347

jonnystening opened this issue Jul 11, 2017 · 1 comment

Comments

@jonnystening
Copy link
Contributor

jonnystening commented Jul 11, 2017

Lets have a discussion regarding GUI-docs... who its written for and where we should take it going forward.

  • Default module naming... Basic/Default? (ie. Primary panel vs Basic button vs Basic table vs Soft tabs)
  • Some modules are named using their plural form, some are not (Basic buttons vs Primary panel vs Soft tabs vs Soft accordion)
  • Can we rethink the categorisation of module documentation? Should Modal doc really live on a page called Popovers? As a dev Popovers are a very common pattern of their own. Should Panels, Tabs and Accordions all live on the one Containers page? By considering a grouping like Bootstrap (every module lives on its own page), it gives us more room to write more detailed documentation and provide examples.
  • We don't currently mention all module modifiers... ie. Modal sizing options
  • Icon documentation is very light. I have added a small mention re colouring (#331 & #337), but this could be more thorough. Icon groups should really be consolidated and brought into example iframes (as per #338 & #339)
  • 'Getting started' section sub pages are very hard to find (e.g. https://gel.westpacgroup.com.au/GUI/WBC/getting-started/installing/). Great content, but needs to be more prevalent
  • FAQ is also hard to find. These long pages with mixed content areas are lost without navigation menu access.
@justinspencer
Copy link
Contributor

  • Each element in GUI docs has an area for a brief description. Originally this was intended to describe the usage of the element however as the GUI has evolved into more of a FED tool this area should probably be used to call out information relating more to developers than designers. Text should still be kept to a minimum.
  • Happy to re-think default module naming (which originally came from Bootstrap).
  • Happy to look at the categorisation of GUI elements but don't want to end up with a massive nav menu. Personally I think Bootstrap categorisation and navigation is just as confusing. Search/tags might be a better solution.
  • The Getting started page has been a tad neglected. We need to look at how we can get this page working harder and looking more engaging. It's been in the backlog for about... 18 months.

@jonnystening jonnystening changed the title GUI documentation consistency Docs: GUI documentation consistency Aug 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants