Merge pull request #143 from basemate/docs_test

jonasjabari · web-flow · commit f08135297849 · 2019-08-17T22:57:58.000+02:00
Support new Doc App
diff --git a/docs/README.md b/docs/README.md
@@ -1,15 +1,10 @@
-# Documentation
-
-## Getting started
-
-1. [Install](./install)
-2. [Concepts](./concepts)
-3. [Core Components](./components)
-4. [Integrations](./integrations)
-5. [Tooling](./tooling_and_ecosystem)
-
-## Diving deeper
-
-6. [Extend](./extend)
-7. [Architecture](./architecture)
-8. [Contribute](./contribute)
+# Table of Contents
+
+1. [Install](/docs/install)
+2. [Concepts](/docs/concepts)
+3. [Core Components](/docs/components)
+4. [Integrations](/docs/integrations)
+5. [Tooling](/docs/tooling)
+6. [Extend](/docs/extend)
+7. [Architecture](/docs/architecture)
+8. [Contribute](/docs/contribute)
diff --git a/docs/architecture/README.md b/docs/architecture/README.md
@@ -4,7 +4,7 @@ In this section, we take a deep dive into how Matestack is implemented.
 
 **The Matestack core was developed while iterating concepts following the main goal of `just making it work`. Therefore, the core is not yet well engineered in some places. After we were happy with it working, we've spent quite some time writing tests to save the status quo, and now we're about to refactor the core.**
 
-Please refer to the [detailed architectural drawing](./matestack_rendering.png) while reading the following documentation.
+Please refer to the [detailed architectural drawing](/docs/architecture/matestack_rendering.png) while reading the following documentation.
 
 ## Example
 
diff --git a/docs/components/README.md b/docs/components/README.md
@@ -1,44 +1,44 @@
 # Core Components
 
 matestack provides a wide set of core components, which enables you to easily build your UI.
-You can build your [own components](../extend/custom_components.md) as well, either static or dynamic.
+You can build your [own components](/docs/extend/custom_components.md) as well, either static or dynamic.
 
 ## Static Core Components
 
-- [div](./div.md)
-- [header](./header.md)
-- [footer](./footer.md)
-- [main](./main.md)
-- [nav](./nav,md)
-- [section](./section.md)
-- [br](./br.md)
-- [hr](./hr.md)
-- [heading](./heading.md)
-- [plain](./plain.md)
-- [pg](./pg.md)
-- [span](./span.md)
-- [icon](./icon.md)
-- [list](./list.md)
+- [div](/docs/components/div.md)
+- [header](/docs/components/header.md)
+- [footer](/docs/components/footer.md)
+- [main](/docs/components/main.md)
+- [nav](/docs/components/nav,md)
+- [section](/docs/components/section.md)
+- [br](/docs/components/br.md)
+- [hr](/docs/components/hr.md)
+- [heading](/docs/components/heading.md)
+- [plain](/docs/components/plain.md)
+- [pg](/docs/components/pg.md)
+- [span](/docs/components/span.md)
+- [icon](/docs/components/icon.md)
+- [list](/docs/components/list.md)
   - ul
   - ol
   - li
-- [table](./table.md)
+- [table](/docs/components/table.md)
   - th
   - tr
   - td
-- [img](./img.md)
-- [video](./video.md)
-- [button](./button.md)
-- [link](./link.md)
-- [label](./label.md)
-- [progress](./progress.md)
+- [img](/docs/components/img.md)
+- [video](/docs/components/video.md)
+- [button](/docs/components/button.md)
+- [link](/docs/components/link.md)
+- [label](/docs/components/label.md)
+- [progress](/docs/components/progress.md)
 
 ## Dynamic Core Components
 
-- [form](./form.md)
+- [form](/docs/components/form.md)
   - form_input
   - form_select
   - form_submit
-- [action](./action.md)
-- [transition](./transition.md)
-- [onclick](./onclick.md)
+- [action](/docs/components/action.md)
+- [transition](/docs/components/transition.md)
+- [onclick](/docs/components/onclick.md)
diff --git a/docs/components/action.md b/docs/components/action.md
@@ -1,6 +1,6 @@
 # matestack core component: Action
 
-Show [specs](../../spec/usage/components/action_spec.rb)
+Show [specs](/spec/usage/components/action_spec.rb)
 
 The action component allows us to trigger HTTP requests!
 
@@ -225,7 +225,7 @@ end
 
 ### Example 3.1: Async request with success event emit used for rerendering
 
-Below, we define an action component and an async component. The async component is documented [here](./async.md),
+Below, we define an action component and an async component. The async component is documented [here](/docs/components/async.md),
 for now it is just important that it waits for our `action_config` success message and will get re-rendered.
 
 ```ruby
diff --git a/docs/components/async.md b/docs/components/async.md
@@ -1,6 +1,6 @@
 # matestack core component: Async
 
-Show [specs](../../spec/usage/components/async_spec.rb)
+Show [specs](/spec/usage/components/async_spec.rb)
 
 As the name suggests, the async component allows us to let our components behave asynchronously!
 
diff --git a/docs/components/blockquote.md b/docs/components/blockquote.md
@@ -1,6 +1,6 @@
 # matestack core component: Blockquote
 
-Show [specs](../../spec/usage/components/blockquote_spec.rb)
+Show [specs](/spec/usage/components/blockquote_spec.rb)
 
 The HTML blockquote tag implemented in ruby.
 
diff --git a/docs/components/br.md b/docs/components/br.md
@@ -1,6 +1,6 @@
 # matestack core component: Br
 
-Show [specs](../../spec/usage/components/br_spec.rb)
+Show [specs](/spec/usage/components/br_spec.rb)
 
 The HTML `<br>` tag implemented in ruby.
 
diff --git a/docs/components/button.md b/docs/components/button.md
@@ -1,6 +1,6 @@
 # matestack core component: Button
 
-Show [specs](../../spec/usage/components/button_spec.rb)
+Show [specs](/spec/usage/components/button_spec.rb)
 
 The HTML `<button>` tag implemented in Ruby.
 
diff --git a/docs/components/caption.md b/docs/components/caption.md
@@ -1,6 +1,6 @@
 # matestack core component: Caption
 
-Show [specs](../../spec/usage/components/caption_spec.rb)
+Show [specs](/spec/usage/components/caption_spec.rb)
 
 The HTML `<caption>` tag implemented in ruby. According to the [W3C specification](https://www.w3schools.com/tags/tag_caption.asp), it defines a table caption, it must be inserted directly after the `<table>` tag, and there should only be one caption per table.
 
diff --git a/docs/components/collection.md b/docs/components/collection.md
@@ -1,6 +1,6 @@
 # matestack core component: Collection
 
-Show [specs](../../spec/usage/components/collection_spec.rb)
+Show [specs](/spec/usage/components/collection_spec.rb)
 
 The `collection` component is designed to
 
diff --git a/docs/components/details.md b/docs/components/details.md
@@ -1,6 +1,6 @@
 # matestack core component: Details
 
-Show [specs](../../spec/usage/components/details_summary_spec.rb)
+Show [specs](/spec/usage/components/details_summary_spec.rb)
 
 Use details to implement `<details>` and `<summary>` tags.
 
diff --git a/docs/components/div.md b/docs/components/div.md
@@ -1,6 +1,6 @@
 # matestack core component: Div
 
-Show [specs](../../spec/usage/components/div_spec.rb)
+Show [specs](/spec/usage/components/div_spec.rb)
 
 The HTML div tag implemented in ruby.
 
diff --git a/docs/components/footer.md b/docs/components/footer.md
@@ -1,6 +1,6 @@
 # matestack core component: Footer
 
-Show [specs](../../spec/usage/components/footer_spec.rb)
+Show [specs](/spec/usage/components/footer_spec.rb)
 
 The HTML footer tag implemented in ruby.
 
diff --git a/docs/components/form.md b/docs/components/form.md
@@ -1,6 +1,6 @@
 # matestack core component: Form
 
-Show [specs](../../spec/usage/components/form_spec.rb)
+Show [specs](/spec/usage/components/form_spec.rb)
 
 ## Parameters
 
diff --git a/docs/components/header.md b/docs/components/header.md
@@ -1,6 +1,6 @@
 # matestack core component: Header
 
-Show [specs](../../spec/usage/components/header_spec.rb)
+Show [specs](/spec/usage/components/header_spec.rb)
 
 The HTML header tag implemented in ruby.
 
diff --git a/docs/components/heading.md b/docs/components/heading.md
@@ -1,6 +1,6 @@
 # matestack core component: Heading
 
-Show [specs](../../spec/usage/components/heading_spec.rb)
+Show [specs](/spec/usage/components/heading_spec.rb)
 
 The HTML heading tag implemented in ruby.
 
diff --git a/docs/components/hr.md b/docs/components/hr.md
@@ -1,6 +1,6 @@
 # matestack core component: Hr
 
-Show [specs](../../spec/usage/components/hr_spec.rb)
+Show [specs](/spec/usage/components/hr_spec.rb)
 
 The HTML `<hr>` tag implemented in ruby.
 
diff --git a/docs/components/icon.md b/docs/components/icon.md
@@ -1,6 +1,6 @@
 # matestack core component: Icon
 
-Show [specs](../../spec/usage/components/icon_spec.rb)
+Show [specs](/spec/usage/components/icon_spec.rb)
 
 The HTML `<i>` tag implemented in ruby. Use it for fancy icons!
 
diff --git a/docs/components/img.md b/docs/components/img.md
@@ -1,6 +1,6 @@
 # matestack core component: Img
 
-Show [specs](../../spec/usage/components/icon_spec.rb)
+Show [specs](/spec/usage/components/icon_spec.rb)
 
 The HTML img tag implemented in ruby.
 
diff --git a/docs/components/label.md b/docs/components/label.md
@@ -1,3 +1,3 @@
 # matestack core component: Label
 
-Show [specs](../../spec/usage/components/label_spec.rb)
+Show [specs](/spec/usage/components/label_spec.rb)
diff --git a/docs/components/link.md b/docs/components/link.md
@@ -1,6 +1,6 @@
 # matestack core component: Link
 
-Show [specs](../../spec/usage/components/link_spec.rb)
+Show [specs](/spec/usage/components/link_spec.rb)
 
 This component is used to either navigate within your matestack application or to send requests to outside URLs.
 
diff --git a/docs/components/list.md b/docs/components/list.md
@@ -1,6 +1,6 @@
 # matestack core component: Lists
 
-Show [specs](../../spec/usage/components/list_spec.rb)
+Show [specs](/spec/usage/components/list_spec.rb)
 
 Use lists to implement `<ol>`, `<ul>` and `<li>`-tags.
 
diff --git a/docs/components/main.md b/docs/components/main.md
@@ -1,6 +1,6 @@
 # matestack core component: Main
 
-Show [specs](../../spec/usage/components/main_spec.rb)
+Show [specs](/spec/usage/components/main_spec.rb)
 
 The HTML main tag implemented in ruby.
 
diff --git a/docs/components/nav.md b/docs/components/nav.md
@@ -1,6 +1,6 @@
 # matestack core component: Nav
 
-Show [specs](../../spec/usage/components/nav_spec.rb)
+Show [specs](/spec/usage/components/nav_spec.rb)
 
 The HTML nav tag implemented in ruby.
 
diff --git a/docs/components/onclick.md b/docs/components/onclick.md
@@ -1,3 +1,3 @@
 # matestack core component: Action
 
-Show [specs](../../spec/usage/components/action_spec.rb)
+Show [specs](/spec/usage/components/action_spec.rb)
diff --git a/docs/components/paragraph.md b/docs/components/paragraph.md
@@ -1,6 +1,6 @@
 # matestack core component: Paragraph
 
-Show [specs](../../spec/usage/components/paragraph_spec.rb)
+Show [specs](/spec/usage/components/paragraph_spec.rb)
 
 The HTML `<p>` tag implemented in ruby. This is a workaround because the single `p` is a reserved keyword in Ruby (directly writes `obj.inspect` followed by a newline to the program’s standard output, e.g. `p foo` equals `puts foo.inspect`).
 
diff --git a/docs/components/pg.md b/docs/components/pg.md
@@ -1,5 +1,5 @@
 # matestack core component: PG
 
-Show [specs](../../spec/usage/components/pg_spec.rb)
+Show [specs](/spec/usage/components/pg_spec.rb)
 
-The HTML `<p>` tag implemented in ruby. Please refer to the [paragraph core component](./paragraph.md) since the PG component is deprecated and will be removed sometime in the future.
+The HTML `<p>` tag implemented in ruby. Please refer to the [paragraph core component](/docs/components/paragraph.md) since the PG component is deprecated and will be removed sometime in the future.
diff --git a/docs/components/plain.md b/docs/components/plain.md
@@ -1,6 +1,6 @@
 # matestack core component: Plain
 
-Show [specs](../../spec/usage/components/plain_spec.rb)
+Show [specs](/spec/usage/components/plain_spec.rb)
 
 This element simply renders the value of a variable (or simple a string) wherever you want it.
 
diff --git a/docs/components/progress.md b/docs/components/progress.md
@@ -1,3 +1,3 @@
 # matestack core component: Progress
 
-Show [specs](../../spec/usage/components/progress_spec.rb)
+Show [specs](/spec/usage/components/progress_spec.rb)
diff --git a/docs/components/section.md b/docs/components/section.md
@@ -1,6 +1,6 @@
 # matestack core component: Section
 
-Show [specs](../../spec/usage/components/section_spec.rb)
+Show [specs](/spec/usage/components/section_spec.rb)
 
 The HTML section tag implemented in ruby.
 
diff --git a/docs/components/small.md b/docs/components/small.md
@@ -1,6 +1,6 @@
 # matestack core component: Small
 
-Show [specs](../../spec/usage/components/small_spec.rb)
+Show [specs](/spec/usage/components/small_spec.rb)
 
 The HTML small tag implemented in ruby.
 
diff --git a/docs/components/span.md b/docs/components/span.md
@@ -1,6 +1,6 @@
 # matestack core component: Span
 
-Show [specs](../../spec/usage/components/span_spec.rb)
+Show [specs](/spec/usage/components/span_spec.rb)
 
 The HTML span tag implemented in ruby.
 
diff --git a/docs/components/strong.md b/docs/components/strong.md
@@ -1,6 +1,6 @@
 # matestack core component: Strong
 
-Show [specs](../../spec/usage/components/strong_spec.rb)
+Show [specs](/spec/usage/components/strong_spec.rb)
 
 The HTML `<strong>` tag implemented in ruby.
 
diff --git a/docs/components/table.md b/docs/components/table.md
@@ -1,6 +1,6 @@
 # matestack core component: Table
 
-Show [specs](../../spec/usage/components/table_spec.rb)
+Show [specs](/spec/usage/components/table_spec.rb)
 
 Use tables to implement `<table>`, `<tr>`, `<th>` and `<td>`-tags.
 
diff --git a/docs/components/transition.md b/docs/components/transition.md
@@ -1,14 +1,14 @@
 # matestack core component: Transition
 
-Show [specs](../../spec/usage/components/transition_spec.rb)
+Show [specs](/spec/usage/components/transition_spec.rb)
 
 ## Parameters
 
 Except for `id` and `class`, the transition component can handle additional parameters:
 
 ### Path
 
-As the name suggests, the `options[:path]` expects a path within our application. If you want to rout to a link outside our application, use the [link component](../link.md)
+As the name suggests, the `options[:path]` expects a path within our application. If you want to rout to a link outside our application, use the [link component](/docs/components/link.md)
 
 ```ruby
 transition path: :page1_path do
diff --git a/docs/components/video.md b/docs/components/video.md
@@ -1,6 +1,6 @@
 # matestack core component: Video
 
-Show [specs](../../spec/usage/components/video_spec.rb)
+Show [specs](/spec/usage/components/video_spec.rb)
 
 The HTML video tag implemented in ruby.
 
diff --git a/docs/concepts/README.md b/docs/concepts/README.md
diff --git a/docs/concepts/app.md b/docs/concepts/app.md
diff --git a/docs/concepts/component.md b/docs/concepts/component.md
diff --git a/docs/concepts/page.md b/docs/concepts/page.md
diff --git a/docs/extend/README.md b/docs/extend/README.md
diff --git a/docs/extend/custom_components.md b/docs/extend/custom_components.md
diff --git a/docs/install/README.md b/docs/install/README.md
diff --git a/docs/integrations/README.md b/docs/integrations/README.md
diff --git a/docs/tooling/README.md b/docs/tooling/README.md
diff --git a/docs/tooling/generators/README.md b/docs/tooling/generators/README.md
diff --git a/docs/tooling/generators/matestack_app_generator.md b/docs/tooling/generators/matestack_app_generator.md
diff --git a/docs/tooling/generators/matestack_component_generator.md b/docs/tooling/generators/matestack_component_generator.md
diff --git a/docs/tooling/generators/matestack_page_generator.md b/docs/tooling/generators/matestack_page_generator.md
diff --git a/guides/README.md b/guides/README.md
diff --git a/guides/hello_world.md b/guides/hello_world.md
diff --git a/spec/usage/README.md b/spec/usage/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# matestack core component: Label`
`2`	`2`
`3`		`-Show [specs](../../spec/usage/components/label_spec.rb)`
	`3`	`+Show [specs](/spec/usage/components/label_spec.rb)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# matestack core component: Action`
`2`	`2`
`3`		`-Show [specs](../../spec/usage/components/action_spec.rb)`
	`3`	`+Show [specs](/spec/usage/components/action_spec.rb)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# matestack core component: Progress`
`2`	`2`
`3`		`-Show [specs](../../spec/usage/components/progress_spec.rb)`
	`3`	`+Show [specs](/spec/usage/components/progress_spec.rb)`