Skip to content

Commit

Permalink
Add tags to a few pages in the documentation (#156)
Browse files Browse the repository at this point in the history
  • Loading branch information
guyca authored Jul 5, 2024
1 parent 08f4705 commit a02ee52
Show file tree
Hide file tree
Showing 15 changed files with 23 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Meta",
"position": 6,
"collapsed": false,
"link": {
"type": "generated-index"
}
}
2 changes: 1 addition & 1 deletion packages/documentation/docs/documentation/meta/eslint.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 1
title: "ESLint plugin"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 3
title: "Graph middlewares"
---

Expand Down
1 change: 1 addition & 0 deletions packages/documentation/docs/documentation/usage/Graphs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 1
tags: [Graph]
---

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 5
title: "Reactivity"
tags: [Observable, MediatorObservable, useObserver, Reactivity]
---

Obsidian is first and foremost a dependency injection library. But it also includes reactive programming features that allow you to observe changes in your data and react to them. This is useful for things like updating the UI when a value changes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 2
title: 'Configurable applications'
toc_max_heading_level: 4
tags: [Testing, Architecture]
---

import Tabs from '@theme/Tabs';
Expand All @@ -20,8 +21,6 @@ In this article we will learn how Obsidian can help us address these concerns.
## Configuring applications with providers
When using Obsidian, dependencies are declared and constructed in classes called Graphs. Each dependency is constructed by a method called a provider which acts as a **Seam**. Lets see how we can leverage them to make our apps flexible and configurable.

<!-- These providers act as **Seams**. -->

:::tip What are Seams?
A seam is a place where you can alter behavior in your program without editing in that place.

Expand Down
1 change: 1 addition & 0 deletions packages/documentation/docs/guides/mockDependencies.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 1
title: 'Mocking dependencies in unit tests'
tags: [Testing, Architecture]
---

Tests are an integral part of any software project. They let you verify that your code works as expected and that it doesn't break when you make changes. We want our tests to be as clear as possible so that developers don't have to waste time figuring out what the test is doing our how to fix it when it fails.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 3
title: 'MVVM architecture with Obsidian'
tags: [MVVM, Architecture, Model, ViewModel, Reactivity, Graph]
---

MVVM (Model-View-ViewModel) is a software architecture widely used in modern front-end development. It emphasizes separation of concerns and improves code structure. In the Model-View-ViewModel pattern, code is organized into three layers:
Expand Down
1 change: 1 addition & 0 deletions packages/documentation/docs/reference/model.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 5
title: 'Model'
tags: [MVVM, Model]
---

`Model` **is an abstract utility class that provides an easy way to observe specific properties of an object.**
Expand Down
1 change: 1 addition & 0 deletions packages/documentation/docs/reference/observable.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 1
title: 'Observable'
tags: [Observable, Reactivity]
---

`Observable` **is a class that represents a stream of values. It is similar to** `Promise` **in that it is a container for a value that will be available in the future. However, unlike **`Promise`**, **`Observable`** can emit multiple values over time.**
Expand Down
5 changes: 2 additions & 3 deletions packages/documentation/docs/reference/testKit/_category_.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
{
"label": "TestKit",
"position": 6,
"collapsed": true,
"collapsed": false,
"link": {
"type": "generated-index",
"description": "Learn how to inject hooks, components and classes with Obsidian."
"type": "generated-index"
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 1
title: 'mockGraphs'
tags: [mockGraphs, Testing, Graph]
---

`mockGraphs` **is a function that is used in tests to replace the implementation of graphs with a mock implementation.**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 2
title: 'mockModel'
tags: [Model, Testing]
---

`mockModel` **is a utility function that allows you to easily mock [models](/docs/reference/model).**
Expand Down
1 change: 1 addition & 0 deletions packages/documentation/docs/reference/useObserver.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 3
title: 'useObserver'
tags: [useObserver, Reactivity]
---

`useObserver` **is a Hook that allows you to react to changes in an observable.**
Expand Down
1 change: 1 addition & 0 deletions packages/documentation/docs/reference/useObservers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 4
title: 'useObservers'
tags: [useObservers, Reactivity]
---

`useObservers` **is a Hook that allows you to react to changes in multiple observables in a single statement.**
Expand Down

0 comments on commit a02ee52

Please sign in to comment.