Skip to content

Commit 024e035

Browse files
committed
adapted links and files in order to be consumed by docs app
1 parent e82e224 commit 024e035

File tree

11 files changed

+22
-9
lines changed

11 files changed

+22
-9
lines changed

docs/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1-
# Documentation
2-
3-
## Getting started
1+
# Table of Contents
42

53
1. [Install](/docs/install)
64
2. [Concepts](/docs/concepts)
75
3. [Core Components](/docs/components)
86
4. [Integrations](/docs/integrations)
9-
5. [Tooling](/docs/tooling_and_ecosystem)
10-
11-
## Diving deeper
12-
7+
5. [Tooling](/docs/tooling)
138
6. [Extend](/docs/extend)
149
7. [Architecture](/docs/architecture)
1510
8. [Contribute](/docs/contribute)

docs/extend/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
# tbd
1+
# Extend
2+
3+
## Custom Components
4+
5+
1. Create custom static Components (coming soon)
6+
2. Create custom dynamic Components (coming soon)

docs/extend/custom_components.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
# Create your own Components
2+
3+
coming soon

docs/tooling/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Tooling
2+
3+
## Generators
4+
5+
1. [App Generator](/docs/tooling/generators/matestack_app_generator.md)
6+
2. [Component Generator](/docs/tooling/generators/matestack_component_generator.md)
7+
3. [Page Generator](/docs/tooling/generators/matestack_page_generator.md)

guides/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Table of Contents
2+
3+
1. [Hello World](/guides/hello_world.md)

guides/hello_world.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Getting from zero to one, quickly
44

5-
*Prerequisite:* We assume you have read and followed the [installation guide](../docs/install), either in a new or existing Rails application.
5+
*Prerequisite:* We assume you have read and followed the [installation guide](/docs/install), either in a new or existing Rails application.
66

77
### Creating your first Matestack app
88

spec/usage/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
We aim for full test coverage. At the moment, we focus on `Capybara` based acceptance tests. It might be useful to read through the tests in order to see how the components are designed in detail.

0 commit comments

Comments
 (0)