envato-archive / guide

Document your application with a living component library and styleguide

https://rubygems.org/gems/guide

MIT License

8 stars 3 forks source link

Add example documents #58

Closed jordanlewiz closed 8 years ago

jordanlewiz commented 8 years ago

Context

The test_app was slightly out of date and missing some examples

Changes

[x] Add example document pages
[x] Add public, unpublished and restricted example documents
[x] Added some intro content
[x] Added link examples
[x] Moved .html.erb files to be next to .rb files as a form of documenting the possbility

ppj commented 8 years ago

LGTM 👍 One question though: Does the test_app have to be under the spec folder? Logically makes sense, but not intuitive... i guess it can live at the root? Thoughts @zubin, @lukearndt?

zubin commented 8 years ago

@ppj It's conventional to put it there for rails engines. I think it makes sense to put it in spec since it's purely test-related.

Perhaps it could be mentioned in the readme? (if it's not already)

Similarly, I think lib/guide/authorisation_spec_helper.rb and lib/guide/consistency_spec_helper.rb should also live within spec too.

fraserxu commented 8 years ago

I kind agree with @ppj because that is more of an example rather than test, no?

zubin commented 8 years ago

@fraserxu I'm not sure. I'd presumed it contained end-to-end tests, but if it's just for demo then perhaps it could be renamed /demo_app.

jordanlewiz commented 8 years ago

@zubin @fraserxu @ppj @lukearndt happy to rename to demo_app. However will do in a separate PR and wait for Luke's feedback as I believe he may have originally named it test_app