Skip to content

Support new Doc App #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion docs/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
52 changes: 26 additions & 26 deletions docs/components/README.md
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 2 additions & 2 deletions docs/components/action.md
Original file line number Diff line number Diff line change
@@ -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!

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/components/async.md
Original file line number Diff line number Diff line change
@@ -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!

Expand Down
2 changes: 1 addition & 1 deletion docs/components/blockquote.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/br.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/button.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/caption.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/collection.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/components/details.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/div.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/footer.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/form.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/components/header.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/heading.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/hr.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/icon.md
Original file line number Diff line number Diff line change
@@ -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!

Expand Down
2 changes: 1 addition & 1 deletion docs/components/img.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/label.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# matestack core component: Label

Show [specs](../../spec/usage/components/label_spec.rb)
Show [specs](/spec/usage/components/label_spec.rb)
2 changes: 1 addition & 1 deletion docs/components/link.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/list.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/main.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/nav.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/onclick.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# matestack core component: Action

Show [specs](../../spec/usage/components/action_spec.rb)
Show [specs](/spec/usage/components/action_spec.rb)
2 changes: 1 addition & 1 deletion docs/components/paragraph.md
Original file line number Diff line number Diff line change
@@ -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`).

Expand Down
4 changes: 2 additions & 2 deletions docs/components/pg.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/components/plain.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/progress.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# matestack core component: Progress

Show [specs](../../spec/usage/components/progress_spec.rb)
Show [specs](/spec/usage/components/progress_spec.rb)
2 changes: 1 addition & 1 deletion docs/components/section.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/small.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/span.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/strong.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/table.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/components/transition.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/components/video.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Loading