user_docs 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f228c6cb3ca1e8592a67e4e0ee6dc8e6a209544606772749a246502176babe6c
-  data.tar.gz: e4ba2e9cda4db54c58b119bcce3dcd10d8885c67e3b624d540b987b16464b0ac
+  metadata.gz: 849b042e18e7828b3c9ddfc27ed4e91c2dd27a173e340207f4c2cfe344945692
+  data.tar.gz: 1d66be1ffade7ce1df335826fe15af8c183c40bb8440bc3d7bb01903793c883f
 SHA512:
-  metadata.gz: cb27d9911c94b771df7694184f2d15cd608deba4502e95b4691d6572367739112e982e63095367707fed1f14aa940b615dc50a31cc41532b4d8a263edaa75ef1
-  data.tar.gz: 5dd84a8f0cd6fe49236d5af72fe7189a89cf7f11cec57486acc42d80bed7bf8ba18f729a3ec6ff3c6d8278a896358d48b45560ad55234c37d76591976d1c931f
+  metadata.gz: b522e44a349e0772df9f00455a7191315f245ab7499669ffd41de91565f55bbb25141b6cc584e44f7f0fd98c78ed19ad2556fa82a0a2b247f9389941e2fa2f66
+  data.tar.gz: 594b24f70aad792d1f0952fcc3a1f7e14b633d0661d9da9c39574d5c21f12d10be6274a9d17c3f24ac4fa90a3557d8df371ae951cfb2a65647feefb32618e663

data/README.md

@@ -3,43 +3,35 @@ UserDocs is an semi-autonomous way to create end-user documentation for your Rai
 
 ## Installation
 0. Ensure you have the VERSION constant defined for your project.
-1. Add this line to your application's Gemfile:
-   ```ruby
-   gem 'user_docs'
-   ```
-   And then execute:
-   ```bash
-   $ bundle
-   ```
-3. Install the required files:
-   ```bash
-   $ rails g user_docs:install
-   ```
-4. Include the UserDocs module in your system tests:
-   ```ruby
-   class ExampleTest < ApplicationSystemTestCase
-     include UserDocs
-
-     test "foo" do
-     end
-   end
-   ```
-5. Generate documentation by running your system tests:
-   ```bash
-   $ rails test:system
-   ```
-6. Push changes to master.
-7. [Enable GitHub Pages docs folder.](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch)
-8. Your documentation should be viewable in the given url within a couple minutes.
+1. Add this line to your application's Gemfile: `gem 'user_docs'`
+2. And then execute: `bundle`
+3. Create procedures, for example: `/docs/feature_two_procedure.rb`
+
+        #!ruby
+        require_relative '../test/application_system_test_case.rb'
+
+        class FeatureOneProcedure < ApplicationSystemTestCase
+          include UserDocs
+
+          test 'action one' do
+            visit '/'
+            accept_alert
+            comment 'Hotel'
+          end
+        end
+
+4. Generate documentation by running your system tests: `rails user_docs:build_site`
+5. Documentation viewable at `/docs`
 
 ## Usage
 Here are the following methods you can use to create documentation:
-* `accept_alert`
-* `click_on`
-* `fill_in`
-* `choose`
-* `save_screenshot`
-* `comment`
+
+*  `accept_alert`
+*  `click_on`
+*  `fill_in`
+*  `choose`
+*  `save_screenshot`
+*  `comment`
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/user_docs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UserDocs
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: user_docs
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - jtopgi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara