docs: add configuration and features

docs/configuration.md

@@ -0,0 +1,87 @@
+## Configuration
+
+The Dotfiles project offers a flexible and customizable configuration system, allowing you to tailor your development environment to your preferences and requirements. The configuration is defined using a data template that includes various settings and options. During the installation process, you will be prompted with interactive questions to configure each section. Here's an explanation of the key configuration options and how to customize them, along with example configurations:
+
+1. **Personal information:** Set your name, email address, and GitHub username by customizing the following variables in the configuration file. You will be prompted to enter these values during the installation process.
+
+   Example configuration:
+
+   ```yaml
+   name: "Your Name"
+   email: "your.email@example.com"
+   github:
+     username: "your-github-username"
+   ```
+
+   These values are used to configure your Git settings, among other things.
+
+2. **System settings:** You can configure various system settings, such as the hostname, whether you're using WSL, and if you're running in a development container. You will be asked about these settings during the installation process.
+
+   Example configuration:
+
+   ```yaml
+   system:
+     hostname: "your-hostname"
+     is_wsl: false
+     is_devcontainer: false
+   ```
+
+3. **SSH settings:** Configure your SSH settings by specifying the home directory, algorithm, identity file, and authorized_keys file. You will be prompted to provide these values during the installation process.
+
+   Example configuration:
+
+   ```yaml
+   ssh:
+     home: "~/.ssh"
+     algorithm: "rsa"
+     identity_file: "id_rsa"
+     authorized_keys: "authorized_keys"
+   ```
+
+4. **GnuPG settings:** Customize your GnuPG settings, including the home directory, key ID file, and passphrase. You will be asked to input these values during the installation process.
+
+   Example configuration:
+
+   ```yaml
+   gnupg:
+     home: "~/.gnupg"
+     key_id_file: "gpg_key_id"
+     passphrase: "your-gpg-passphrase"
+   ```
+
+5. **Workspace settings:** Configure your workspace by specifying the name, location, project directory, and reference directory. You will be prompted to provide these values during the installation process.
+
+   Example configuration:
+
+   ```yaml
+   workspace:
+     name: "your-workspace-name"
+     location: "~/your-workspace-location"
+     project_dir: "Projects"
+     reference_dir: "References"
+   ```
+
+6. **Integrated tools:** Enable or disable specific tools and their related configurations, such as Docker, Visual Studio Code, or Python tools. You will be asked about these settings during the installation process.
+
+   Example configuration:
+
+   ```yaml
+   docker:
+     enabled: true
+   code:
+     enabled: true
+   python_tools:
+     enabled: true
+   ```
+
+7. **GitHub repositories:** Add a list of GitHub repositories to clone automatically during the setup process. You will be prompted to enter these values during the installation process.
+
+   Example configuration:
+
+   ```yaml
+   github_repos:
+     - name: "repo-owner/repo-name"
+       url: "/~https://github.com/repo-owner/repo-name.git"
+   ```
+
+To customize your Dotfiles configuration, simply answer the interactive prompts during the installation process. This will ensure that your development environment is tailored to your specific preferences and requirements, making it more efficient and enjoyable to work with.

docs/features.md

@@ -0,0 +1,21 @@
+## Features
+
+The Dotfiles project offers an extensive set of features to help you manage and configure your development environment with ease. These features are designed to simplify your workflow, improve productivity, and ensure consistency across different systems. Here are some of the key features of the Dotfiles project:
+
+1. **Personalized configuration:** Dotfiles allows you to define various personal settings, such as your name, email address, preferred text editor, and GitHub username. This ensures that your development environment is tailored to your preferences and requirements.
+
+2. **Cross-platform support:** Dotfiles supports multiple platforms, including Linux, macOS, and Windows. This enables you to maintain a consistent development environment across various operating systems.
+
+3. **Version control integration:** Dotfiles integrates with Git for version control, making it easy to track changes, collaborate with others, and revert to previous versions of your configuration files when necessary.
+
+4. **Flexible configuration management:** Dotfiles uses the `chezmoi` tool to manage your configuration files, which allows you to easily synchronize your configurations across multiple devices and keep them up to date.
+
+5. **Extensive tool support:** Dotfiles includes configurations for a wide range of development tools, such as text editors, terminals, version control systems, and more. This ensures that you have access to your preferred tools regardless of the system you're working on.
+
+6. **Modular structure:** The Dotfiles project features a modular structure, making it easy to manage and maintain your configuration files. You can easily add, remove, or modify individual components without affecting the rest of your configuration.
+
+7. **Customizable workspace setup:** Dotfiles allows you to configure your workspace, including specifying the location, project directory, and reference directory. This helps you maintain an organized and efficient development environment.
+
+8. **Automated installation and initialization:** The Dotfiles project streamlines the installation and initialization process using a single command. This makes it easy to set up your development environment quickly and consistently across different devices.
+
+9. **Comprehensive documentation:** The Dotfiles project provides extensive documentation to help you understand and customize your development environment. This makes it easy to get started and tailor your setup to your needs.

mkdocs.yaml

@@ -47,4 +47,6 @@ extra:
 nav:
   - Home: index.md
   - Usage: usage.md
+  - Configuration: configuration.md
+  - Features: features.md
   - References: references.md