Skip to content

Commit

Permalink
docs: Improve Features documentation structure
Browse files Browse the repository at this point in the history
  • Loading branch information
xmnlab committed Dec 8, 2023
1 parent 1f09d38 commit 85abbb3
Showing 1 changed file with 3 additions and 19 deletions.
22 changes: 3 additions & 19 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Makim Features
# Features

## Working Directory Feature
## Attribute: working-directory

The working-directory feature in Makim allows users to define the directory
from which commands associated with specific targets or groups are executed.
This provides greater flexibility and control over the execution environment.

### Attribute: working-directory

The `working-directory` attribute can be specified at three different
scopes: global, group, and target. It allows users to set the working
directory for a specific target, a group of targets, or globally.
Expand Down Expand Up @@ -57,7 +55,7 @@ The working-directory attribute can be applied to three different scopes:
targets:
my-target:
working-directory: /path/to/target/directory
run: |
run: |
# This target will run with the working directory set to
# /path/to/target/directory
```
Expand Down Expand Up @@ -86,18 +84,4 @@ groups:
echo "Running backend tests..."
# Additional test commands specific to the backend
frontend:
working-directory: frontend
targets:
build:
help: Build the frontend application
run: |
echo "Building frontend application..."
# Additional build commands specific to the frontend
test:
help: Run frontend tests
run: |
echo "Running frontend tests..."
# Additional test commands specific to the frontend
```

0 comments on commit 85abbb3

Please sign in to comment.