docs: Improve section Features with more makim features

[xmnlab]

Currently https://osl-incubator.github.io/makim/features/ just has the documentation for one attribute: working-directory.

It would be nice to have a complete list of attributes and their documentation. It should be organized in a nested way, according to the .makim.yaml structure:

• [ ] version
• groups
  • [ ] default
  • [ ] env-file
  • targets:
    • [ ] TARGET-NAME
    • [ ] help: Use this target to clean up temporary files
    • [ ] args
    • [ ] run
    • [ ] dependencies

This would be a nice issue to tackle in order to get familiarized with makim. the documentation file to be changed is this one: https://github.com/osl-incubator/makim/blob/main/docs/features.md

[xmnlab]

@Tyagiquamar could you work on this issue please?

[Tyagiquamar]

@xmnlab it means that I have to change the features.md to add all the attributes? I will try my best

[xmnlab]

yes please. thank you.

[xmnlab]

Example:

# MakIm Configuration File Reference

The `.makim.yaml` file is a central part of defining and managing your MakIm project configurations. This document outlines the structure and options available within a `.makim.yaml` file.

## Structure Overview

A `.makim.yaml` file is structured into several sections:

- `version`: Specifies the version of the MakIm file format.
- `env-file`: Specifies a global environment file.
- `shell`: Defines the default shell for running commands.
- `groups`: Organizes targets into named groups.
- `targets`: Defines the actions or commands that can be executed.
- `env`: Sets environment variables at different scopes.
- `dependencies`: Lists other targets that must be run before the current one.
- `working-directory`: Sets the working directory for the command execution.

### Version

Specifies the `.makim.yaml` file format version being used.

```yaml
version: 1.0

Env-file

Specifies a path to an environment file that should be loaded before executing any commands.

env-file: .env

Shell

Defines the default shell for executing the commands. It can be overridden at the group or target level.

shell: bash

Groups

Organizes targets into named groups, allowing for structured and modular command definitions.

groups:
  group-name:
    shell: bash
    env-file: .env-group
    env:
      VAR: "value"
    targets:
      target-name:
        # Target configuration

Group Configuration

• shell: Optionally override the global shell setting for all targets in the group.
• env-file: Specify a group-specific environment file.
• env: Define environment variables available to all targets within the group.

Targets

Defines the actions or commands that can be executed. Targets can include arguments, dependencies, and specific run commands.

targets:
  clean:
    help: "Remove all temporary files"
    run: |
      echo "Cleaning up..."

Target Configuration

• help: Provides a description of what the target does.
• args: Defines arguments that can be passed to the target.
• dependencies: Lists other targets that must be run before this one.
• run: The command(s) to be executed for this target.

Env

Sets environment variables. These can be defined at the global level, within a group, or within a specific target.

env:
  GLOBAL_VAR: "value"

Dependencies

Specifies other targets that must be run before the current target. Dependencies can include conditions and arguments.

dependencies:
  - target: another-target
    if: "{{ args.condition }}"

Working-directory

Sets the working directory from which the command should be executed. This can be defined globally, for a group, or for a specific target.

working-directory: "/path/to/directory"

Examples

Here, provide comprehensive examples that demonstrate various features and configurations of .makim.yaml files. Show how to set up simple to complex workflows, utilize environment variables, define dependencies with conditions, and how to organize commands into groups.