Moved supplemental file to pages from docs.

ohler55 · Apr 23, 2017 · 6ba8b89 · 6ba8b89
1 parent 207ea1a
commit 6ba8b89
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 24 deletions.
diff --git a/.yardopts b/.yardopts
@@ -2,14 +2,14 @@
 --readme README.md
 --charset utf-8
 -
-docs/Advanced.md
-docs/Compatibility.md
-docs/Custom.md
-docs/Encoding.md
-docs/JsonGem.md
-docs/Modes.md
-docs/Options.md
-docs/Rails.md
-docs/Security.md
+pages/Advanced.md
+pages/Compatibility.md
+pages/Custom.md
+pages/Encoding.md
+pages/JsonGem.md
+pages/Modes.md
+pages/Options.md
+pages/Rails.md
+pages/Security.md
 CHANGELOG.md
 LICENSE
diff --git a/README.md b/README.md
@@ -47,15 +47,15 @@ gem 'oj'
 For more details on options, modes, advanced features, and more follow these
 links.
 
- - [{file:Options.md}](docs/Options.md) for parse and dump options.
- - [{file:Modes.md}](docs/Modes.md) for details on modes for strict JSON compliance, mimicing the JSON gem, and mimicing Rails and ActiveSupport behavior.
- - [{file:JsonGem.md}](docs/JsonGem.md) includes more details on json gem compatibility and use.
- - [{file:Rails.md}](docs/Rails.md) includes more details on Rails and ActiveSupport compatibility and use.
- - [{file:Custom.md}](docs/Custom.md) includes more details on Custom mode.
- - [{file:Encoding.md}](docs/Encoding.md) describes the :object encoding format.
- - [{file:Compatibility.md}](docs/Compatibility.md) lists current compatibility with Rubys and Rails.
- - [{file:Advanced.md}](docs/Advanced.md) for fast parser and marshalling features.
- - [{file:Security.md}](docs/Security.md) for security considerations.
+ - [{file:Options.md}](pages/Options.md) for parse and dump options.
+ - [{file:Modes.md}](pages/Modes.md) for details on modes for strict JSON compliance, mimicing the JSON gem, and mimicing Rails and ActiveSupport behavior.
+ - [{file:JsonGem.md}](pages/JsonGem.md) includes more details on json gem compatibility and use.
+ - [{file:Rails.md}](pages/Rails.md) includes more details on Rails and ActiveSupport compatibility and use.
+ - [{file:Custom.md}](pages/Custom.md) includes more details on Custom mode.
+ - [{file:Encoding.md}](pages/Encoding.md) describes the :object encoding format.
+ - [{file:Compatibility.md}](pages/Compatibility.md) lists current compatibility with Rubys and Rails.
+ - [{file:Advanced.md}](pages/Advanced.md) for fast parser and marshalling features.
+ - [{file:Security.md}](pages/Security.md) for security considerations.
 
 ## Releases
 

diff --git a/oj.gemspec b/oj.gemspec
@@ -13,12 +13,12 @@ Gem::Specification.new do |s|
   s.description = %{The fastest JSON parser and object serializer. }
   s.licenses = ['MIT']
 
-  s.files = Dir["{lib,ext,test}/**/*.{rb,h,c}"] + ['LICENSE', 'README.md'] + Dir["docs/*.md"]
+  s.files = Dir["{lib,ext,test}/**/*.{rb,h,c}"] + ['LICENSE', 'README.md'] + Dir["pages/*.md"]
   s.test_files = Dir["test/**/*.rb"]
   s.extensions = ["ext/oj/extconf.rb"]
 
   s.has_rdoc = true
-  s.extra_rdoc_files = ['README.md'] + Dir["docs/*.md"]
+  s.extra_rdoc_files = ['README.md'] + Dir["pages/*.md"]
   s.rdoc_options = ['--title', 'Oj', '--main', 'README.md']
 
   s.rubyforge_project = 'oj'

diff --git a/docs/Advanced.md → pages/Advanced.md b/docs/Advanced.md → pages/Advanced.md
diff --git a/docs/Compatibility.md → pages/Compatibility.md b/docs/Compatibility.md → pages/Compatibility.md
diff --git a/docs/Custom.md → pages/Custom.md b/docs/Custom.md → pages/Custom.md
diff --git a/docs/Encoding.md → pages/Encoding.md b/docs/Encoding.md → pages/Encoding.md
diff --git a/docs/JsonGem.md → pages/JsonGem.md b/docs/JsonGem.md → pages/JsonGem.md
diff --git a/docs/Modes.md → pages/Modes.md b/docs/Modes.md → pages/Modes.md
@@ -39,15 +39,15 @@ if a non-native type is encountered instead of raising an Exception.
 The `:compat` mode mimics the json gem. The json gem is built around the use
 of the `to_json(*)` method defined for a class. Oj attempts to provide the
 same functionality by being a drop in replacement with a few
-exceptions. [{file:JsonGem.md}](docs/JsonGem.md) includes more details on
+exceptions. [{file:JsonGem.md}](pages/JsonGem.md) includes more details on
 compatibility and use.
 
 ## :rails Mode
 
 The `:rails` mode mimics the ActiveSupport version 5 encoder. Rails and
 ActiveSupport are built around the use of the `as_json(*)` method defined for
 a class. Oj attempts to provide the same functionality by being a drop in
-replacement with a few exceptions. [{file:Rails.md}](docs/Rails.md) includes
+replacement with a few exceptions. [{file:Rails.md}](pages/Rails.md) includes
 more details on compatibility and use.
 
 ## :object Mode
@@ -58,7 +58,7 @@ default mode unless changed in the Oj default options. In :object mode Oj
 generates JSON that follows conventions which allow Class and other
 information such as Object IDs for circular reference detection to be encoded
 in a JSON document. The formatting follows the rules describe on the
-[{file:Encoding.md}](docs/Encoding.md) page.
+[{file:Encoding.md}](pages/Encoding.md) page.
 
 ## :custom Mode
 
@@ -68,7 +68,7 @@ some special aspect that makes it unique. For example, the `:object` mode has
 it's own unique format for object dumping and loading. The `:compat` mode
 mimic the json gem including methods called for encoding and inconsistencies
 between `JSON.dump()`, `JSON.generate()`, and `JSON()`. More details on the
-[{file:Custom.md}](docs/Custom.md) page.
+[{file:Custom.md}](pages/Custom.md) page.
 
 ## Options Matrix
 

diff --git a/docs/Options.md → pages/Options.md b/docs/Options.md → pages/Options.md
diff --git a/docs/Rails.md → pages/Rails.md b/docs/Rails.md → pages/Rails.md
diff --git a/docs/Security.md → pages/Security.md b/docs/Security.md → pages/Security.md