Improve website usability

[tyrw]

Enhancement

It's hard to navigate the docs site, particularly the homepage schemaform.io and the examples pages. This adds to frustration each time and decreases likelyhood that people will use the tool.

Expected behaviour

I expected an easy-to-find docs button on the home page, and reasonably sized font on examples page (it is huge).

Actual behaviour

It requires scrolling on home page to even find the docs or demo button. Screen space at the top is instead dedicated to a carousel that mocks itself for being a useless picture of wheat. Mildly amusing the first time I saw it; but being honest it makes me want to find an alternative every time since.

Examples page is borderline unusable because the code samples look huge.

Gist/Plunker/Demo

Not useful (at least add demos / docs buttons to the top):

Screen view on macbook pro screen. Code font is far too large for panel size. Scrolling up and down is a pain when trying to read the schema:

@json-schema-form/angular-schema-form-lead

[RPGillespie6]

This is very true. It's extremely difficult to find a complete working example anywhere. Even the demo page just gives you JSON, when what I really need is the code that goes into the angular module, controller, html, etc. The JSON is the easy part.

A complete, minimal JSFiddle would be a good start.

For example, I burned an hour just to figure out that there are 4 required dependencies just to get it working:

    "tv4/tv4.js",
    "objectpath/lib/ObjectPath.js",
    "angular-schema-form/dist/schema-form.js",
    "angular-schema-form/dist/bootstrap-decorator.js"

[Anthropic]

@tyrw agreed, thanks for the feedback, I've had the same thoughts myself. I'm looking into dgeni to see if we can generate a documentation based site at some point, but we rely on community contributions, so unless someone is willing to mock up a basic website for us or make a PR I have to focus on functionality for work more than anything else.

@RPGillespie6 check this Plunker out https://plnkr.co/edit/hukXFi?p=preview, do you think it meets the need you described? @nicklasb just put it together and we will add a link to it from the readme, open to enhancement suggestions too. ps. it is for the alpha version.

[tyrw]

@Anthropic very much understand. It is noteworthy though that in the time since I made the initial comment, we ended up rolling our own literally because the documentation is too painful to navigate. The main culprit honestly is the giant font size for the schema page. It seems like that would be a 5 minute fix, but I don't have a dog in the fight anymore. Thanks for running the project either way!

[nicklasb]

@RPGillespie6 It should be noted, WRT dependencies, that they are listed on the front page of the git repo: https://github.com/json-schema-form/angular-schema-form#script-loading

So they also include angular and angular-sanitize. And that ObjectPath is included in >1.0.

[RPGillespie6]

@Anthropic Looks good to me. That would have saved me a lot of time having a complete working example and I'm sure it will help others.

@nicklasb That's where I eventually found them, however the landing page for this library from google for me was http://schemaform.io/ and from that landing page I spent a lot of time trying to get an example working from the demo and documentation. If I had known the github readme was more useful than the demo and documentation for bootstrapping yourself I would have gone there first, but alas.

[nicklasb]

@RPGillespie6 Ok, I guess I am a bit github-centric, perhaps. But of course there should be a link.

[scottux]

@Anthropic I am familiar with dgeni and can make some minor tweaks to the examples page some time this week.