Skip to content

Commit

Permalink
docs: add examples section, commitlint TIP
Browse files Browse the repository at this point in the history
  • Loading branch information
Avivbens committed Jun 6, 2024
1 parent 8f7082a commit b40cbdc
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/.vitepress/sidebar.config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { DefaultTheme } from 'vitepress'
export const SIDEBAR: DefaultTheme.Sidebar = [
{
text: 'Setup',
base: '/app/setup/',
base: 'app/setup/',
link: '../quick-start',
collapsed: false,
items: [
Expand All @@ -27,7 +27,7 @@ export const SIDEBAR: DefaultTheme.Sidebar = [
},
{
text: 'CI / CD 🐙',
base: '/app/ci/',
base: 'app/ci/',
collapsed: false,
items: [
{
Expand All @@ -42,12 +42,12 @@ export const SIDEBAR: DefaultTheme.Sidebar = [
},
{
text: 'Client',
base: '/app/client/',
base: 'app/client/',
link: 'client',
},
{
text: 'Troubleshooting',
base: '/app/troubleshooting/',
base: 'app/troubleshooting/',
link: 'index',
collapsed: false,
items: [
Expand All @@ -65,4 +65,9 @@ export const SIDEBAR: DefaultTheme.Sidebar = [
},
],
},
{
text: 'Examples 💡',
base: 'app/',
link: 'examples',
},
]
4 changes: 4 additions & 0 deletions docs/app/ci/semantic-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ At the end of this process, you'd be able to publish your Workflow into GitHub R
npm install semantic-release @semantic-release/{changelog,commit-analyzer,exec,git,github,release-notes-generator}
```

::: tip TIP :zap:
It is very recommended to use tools for commit message enforcement like [`commitlint`](https://github.com/conventional-changelog/commitlint?tab=readme-ov-file#readme)
:::

## Setup

::: warning Note :warning:
Expand Down
14 changes: 14 additions & 0 deletions docs/app/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
prev: false
next: false
---

# Examples :bulb:

### Description

In here, you can find a list of real-life Workflows examples that demonstrate how to use `fast-alfred` in various scenarios.

## [Search Bookmarks 👀](https://github.com/Avivbens/alfred-search-bookmark?tab=readme-ov-file#readme)

Search browser bookmarks in all your Chrome profiles.
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ hero:
- theme: alt
text: Troubleshooting
link: /app/troubleshooting/index
- theme: alt
text: Examples
link: /app/examples
features:
- title: Node.js Runtime
link: '/app/setup/runtime-explain'
Expand Down

0 comments on commit b40cbdc

Please sign in to comment.