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 documentation #148

Open
5 of 9 tasks
kbrabrand opened this issue Dec 4, 2018 · 0 comments
Open
5 of 9 tasks

Improve documentation #148

kbrabrand opened this issue Dec 4, 2018 · 0 comments

Comments

@kbrabrand
Copy link
Contributor

kbrabrand commented Dec 4, 2018

Security

  • Fix security warnings from npm

Bugs

  • Fix broken example project 😱– outdated schema
  • Fix broken travis build
  • Remove/add content for "Navigation" chapters
  • Syntax error in code examples in documentation. Run all of them through the validator to make sure they're all correct and that they do what we say they do

Content

  • Document the process of setting up a new project, installing losen and getting started
  • Rewrite the Getting started chapter. "The wizard component" is a bit hard to read, and the rest is not really very good either.
  • Use bullet/numbered lists instead of long paragraphs. Throughout the storybook
  • Rework the building block page. Too hard to read, lack of hierarchy (heading levels and such) and confusing with the list of properties that is shared amongst all the input types
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

1 participant