Merge pull request #143 from basemate/docs_test

Support new Doc App

Author: jonasjabari

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)

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
 

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)

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

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!
 

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.
 

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.
 

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.
 

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.
 

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