@sp-days-framework/create-sp-days 1.0.4 → 1.1.0-beta1

package/templates/addon-resources/resources/environment-setup.mdx

@@ -0,0 +1,317 @@
+---
+sidebar_label: "Environment Setup"
+sidebar_custom_props:
+  section: "Templates"
+  section_position: 1
+---
+
+{/*
+
+Environment Setup pages guide users through installation and preparation of their development 
+environment. Include prerequisites, step-by-step installation instructions for multiple platforms, 
+and verification steps to ensure everything is working correctly.
+
+*/}
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Environment Setup Template
+
+Complete guide to installing and configuring your development environment.
+
+## Prerequisites
+
+Before you begin, ensure you have the following installed:
+
+- **Operating System:** Linux, macOS, or Windows 10/11
+- **Required Software:**
+  - Node.js 18.x or higher
+  - Git 2.x or higher
+  - A text editor or IDE (VS Code, IntelliJ, etc.)
+
+## Installation
+
+<Tabs groupId="operating-systems">
+<TabItem value="linux" label="Linux">
+
+### Using Package Manager
+
+```bash title="install.sh"
+# Ubuntu/Debian
+curl -fsSL https://example.com/install.sh | bash
+sudo apt-get update
+sudo apt-get install -y example-tool
+
+# Fedora/RHEL
+sudo dnf install -y example-tool
+
+# Arch Linux
+sudo pacman -S example-tool
+```
+
+### Manual Installation
+
+```bash
+# Download and extract
+wget https://example.com/releases/latest/example-tool-linux.tar.gz
+tar -xzf example-tool-linux.tar.gz
+sudo mv example-tool /usr/local/bin/
+
+# Verify installation
+example-tool --version
+```
+
+</TabItem>
+<TabItem value="macos" label="macOS">
+
+### Using Homebrew
+
+```bash
+# Install via Homebrew (recommended)
+brew tap example/tap
+brew install example-tool
+
+# Verify installation
+example-tool --version
+```
+
+### Manual Installation
+
+```bash
+# Download and install
+curl -L https://example.com/releases/latest/example-tool-macos.tar.gz -o example-tool.tar.gz
+tar -xzf example-tool.tar.gz
+sudo mv example-tool /usr/local/bin/
+
+# Verify installation
+example-tool --version
+```
+
+</TabItem>
+<TabItem value="windows" label="Windows">
+
+### Using Package Manager
+
+```powershell
+# Using Chocolatey
+choco install example-tool
+
+# Using Scoop
+scoop install example-tool
+
+# Using Winget
+winget install Example.Tool
+```
+
+### Manual Installation
+
+1. Download the installer from [releases page](https://example.com/releases)
+2. Run the `.exe` or `.msi` installer
+3. Follow the installation wizard
+4. Add to PATH if not done automatically
+
+```powershell
+# Verify installation
+example-tool --version
+```
+
+</TabItem>
+</Tabs>
+
+## Configuration
+
+### Initial Setup
+
+After installation, run the initialization command:
+
+```bash
+# Initialize configuration
+example-tool init
+
+# Configure user settings
+example-tool config set user.name "Your Name"
+example-tool config set user.email "your.email@example.com"
+```
+
+### Configuration File
+
+Create a configuration file in your home directory:
+
+```yaml title="~/.example-tool/config.yml"
+user:
+  name: Your Name
+  email: your.email@example.com
+
+defaults:
+  editor: code
+  shell: bash
+
+preferences:
+  auto_update: true
+  telemetry: false
+```
+
+## Development Environment
+
+### Setting Up a Project
+
+```bash
+# Create a new project directory
+mkdir my-project
+cd my-project
+
+# Initialize the project
+example-tool init --template basic
+
+# Install dependencies
+npm install
+```
+
+### Environment Variables
+
+Set up required environment variables:
+
+```bash title=".env"
+# API Configuration
+EXAMPLE_API_KEY=your_api_key_here
+EXAMPLE_ENDPOINT=https://api.example.com
+
+# Development Settings
+NODE_ENV=development
+LOG_LEVEL=debug
+```
+
+Load environment variables:
+
+<Tabs>
+<TabItem value="bash" label="Bash/Zsh">
+
+```bash
+# Add to ~/.bashrc or ~/.zshrc
+export EXAMPLE_API_KEY="your_api_key_here"
+export EXAMPLE_ENDPOINT="https://api.example.com"
+```
+
+</TabItem>
+<TabItem value="fish" label="Fish">
+
+```fish
+# Add to ~/.config/fish/config.fish
+set -x EXAMPLE_API_KEY "your_api_key_here"
+set -x EXAMPLE_ENDPOINT "https://api.example.com"
+```
+
+</TabItem>
+</Tabs>
+
+## Verification
+
+Verify your installation is working correctly:
+
+```bash
+# Check version
+example-tool --version
+
+# Run diagnostic
+example-tool doctor
+
+# Test basic functionality
+example-tool test connection
+```
+
+Expected output:
+
+```
+✓ Example Tool v1.2.3
+✓ Configuration loaded
+✓ API connection successful
+✓ All systems operational
+```
+
+## Updating
+
+Keep your installation up to date:
+
+<Tabs groupId="operating-systems">
+<TabItem value="linux" label="Linux">
+
+```bash
+# Update via package manager
+sudo apt-get update && sudo apt-get upgrade example-tool
+
+# Or use built-in updater
+example-tool update
+```
+
+</TabItem>
+<TabItem value="macos" label="macOS">
+
+```bash
+# Update via Homebrew
+brew upgrade example-tool
+
+# Or use built-in updater
+example-tool update
+```
+
+</TabItem>
+<TabItem value="windows" label="Windows">
+
+```powershell
+# Update via package manager
+choco upgrade example-tool
+
+# Or use built-in updater
+example-tool update
+```
+
+</TabItem>
+</Tabs>
+
+## Troubleshooting Installation
+
+### Command Not Found
+
+If you get "command not found" errors:
+
+```bash
+# Check if installed
+which example-tool
+
+# Check PATH
+echo $PATH
+
+# Add to PATH manually
+export PATH="$PATH:/path/to/example-tool"
+```
+
+### Permission Denied
+
+On Linux/macOS, you may need to make the binary executable:
+
+```bash
+chmod +x /usr/local/bin/example-tool
+```
+
+### Port Already in Use
+
+If the default port is occupied:
+
+```bash
+# Use a different port
+example-tool start --port 9000
+
+# Or stop the conflicting process
+lsof -ti:8080 | xargs kill -9
+```
+
+:::tip Next Steps
+Once your environment is set up, check out the [Quick Start](#) guide to create your first project.
+:::
+
+:::note System Requirements
+- **Minimum:** 2GB RAM, 500MB disk space
+- **Recommended:** 4GB RAM, 1GB disk space
+- **Network:** Internet connection for installation and updates
+:::

package/templates/addon-resources/resources/faq.mdx

@@ -0,0 +1,146 @@
+---
+sidebar_label: "FAQ"
+sidebar_custom_props:
+  section: "Templates"
+  section_position: 1
+---
+
+{/*
+
+FAQ pages answer frequently asked questions in a clear, concise format. Group related questions 
+by category and provide direct, actionable answers. Keep answers brief but complete – link to 
+other resources for detailed explanations.
+
+*/}
+
+# Frequently Asked Questions Template
+
+Common questions and answers to help you get the most out of this technology.
+
+## What platforms are supported?
+
+Fully supported on:
+- Linux (Ubuntu, Debian, Fedora, Arch)
+- Windows (Windows 10 and 11)
+
+## How do I install the tool?
+
+Installation varies by platform. See the [Environment Setup](#) guide for detailed instructions. Quick install:
+
+```bash
+# Linux/macOS
+curl -fsSL https://example.com/install.sh | bash
+
+# Windows (PowerShell)
+winget install Example.Tool
+```
+
+## Where is the configuration file located?
+
+Configuration files are checked in this order:
+1. `./config.yml` (project directory)
+2. `~/.config/example-tool/config.yml` (user home)
+3. `/etc/example-tool/config.yml` (system-wide)
+
+## How do I update to the latest version?
+
+```bash
+# Using built-in updater
+example-tool update
+
+# Or reinstall via package manager
+brew upgrade example-tool  # macOS
+apt-get upgrade example-tool  # Ubuntu/Debian
+```
+
+## How do I initialize a new project?
+
+```bash
+mkdir my-project
+cd my-project
+example-tool init
+```
+
+## Can I use this with Docker?
+
+Yes, official Docker images are available:
+
+```bash
+docker pull example/tool:latest
+docker run -v $(pwd):/app example/tool:latest command
+```
+
+## How do I change the default port?
+
+Update your configuration file or use environment variables:
+
+```yaml
+# config.yml
+server:
+  port: 9000
+```
+
+```bash
+# Or via environment variable
+export SERVER_PORT=9000
+```
+
+## How do I validate my configuration?
+
+```bash
+example-tool config validate
+```
+
+## Why am I getting "command not found"?
+
+The tool isn't in your PATH. Add it manually:
+
+```bash
+export PATH="$PATH:/path/to/example-tool"
+
+# Make permanent (add to ~/.bashrc or ~/.zshrc)
+echo 'export PATH="$PATH:/usr/local/bin"' >> ~/.bashrc
+```
+
+## Why can't I connect to the API?
+
+Check these common issues:
+1. Verify the endpoint URL in your configuration
+2. Ensure your API key is valid and not expired
+3. Check network connectivity and firewall rules
+4. Verify the service is running
+
+```bash
+# Test connectivity
+curl -I https://api.example.com/health
+```
+
+## How do I enable debug logging?
+
+```bash
+# Via CLI flag
+example-tool --verbose command
+
+# Via environment variable
+export LOG_LEVEL=debug
+example-tool command
+
+# Via config file
+logging:
+  level: debug
+```
+
+## What should I do if I encounter an error?
+
+1. Check the error message and error code
+2. Review the [Troubleshooting](#) guide
+3. Enable debug logging to get more details
+4. Search existing GitHub issues
+5. Create a new issue with logs and steps to reproduce
+
+## Is there a REST API client library?
+
+Official clients are available for:
+- JavaScript/TypeScript (npm: `@example/client`)
+- Python (pip: `example-tool-client`)
+- Go (github.com/example/go-client)

package/templates/addon-resources/resources/glossary.mdx

@@ -0,0 +1,78 @@
+---
+sidebar_label: "Glossary"
+sidebar_custom_props:
+  section: "Templates"
+  section_position: 1
+---
+
+{/*
+
+Glossary pages define technology-specific terminology and concepts. Organize alphabetically 
+or by category. Provide clear, concise definitions without assuming prior knowledge. Use 
+examples where helpful to illustrate complex concepts.
+
+*/}
+
+# Glossary Template
+
+Key terms and concepts explained to help you understand the technology and its documentation.
+
+## API (Application Programming Interface)
+A set of rules and protocols that allows different software applications to communicate with each other. In this context, the REST API provides programmatic access to all features.
+
+## Batch Operation
+An operation that processes multiple items in a single request, improving efficiency compared to individual operations. Example: deleting multiple resources at once.
+
+## CLI (Command-Line Interface)
+A text-based interface for interacting with the tool through terminal commands. Alternative to graphical user interfaces (GUI) or APIs.
+
+## Dependency
+External code libraries or tools required for an application to function. Managed through package managers like npm, pip, or Maven.
+
+## Environment Variable
+A dynamic value stored outside the application code that can affect how processes run. Used for configuration and secrets management.
+
+## Flag
+A command-line option that modifies the behavior of a command. Flags typically start with `-` or `--`. Example: `--verbose` for detailed output.
+
+## Hook
+A custom script or function that runs at specific points in a workflow, allowing customization of behavior. Example: pre-deployment hooks for validation.
+
+## Idempotent
+An operation that produces the same result regardless of how many times it's executed. Example: setting a value to "X" is idempotent; incrementing is not.
+
+## JSON (JavaScript Object Notation)
+A lightweight data interchange format that's easy for humans to read and machines to parse. Commonly used for API responses and configuration.
+
+## Lifecycle
+The stages a resource goes through from creation to deletion: initialize → create → update → delete. Hooks and events can be triggered at each stage.
+
+## Middleware
+Software that sits between the client and the server, processing requests and responses. Used for authentication, logging, error handling, etc.
+
+## Namespace
+A logical grouping or container for resources that provides isolation. Prevents naming conflicts and allows organization of related items.
+
+## Orchestration
+The automated coordination and management of multiple components or services. Examples include container orchestration (Kubernetes) and workflow orchestration.
+
+## Plugin
+An extension that adds functionality to the core tool without modifying the main codebase. Plugins enable customization and third-party integrations.
+
+## REST (Representational State Transfer)
+An architectural style for designing APIs that uses HTTP methods (GET, POST, PUT, DELETE) and follows specific conventions.
+
+## Schema
+A structured definition of data format, including field names, types, and validation rules. Used for validating configuration files and API requests.
+
+## Template
+A predefined pattern or blueprint used to generate new resources with consistent structure. Templates can include variables and conditional logic.
+
+## Version Control
+A system for tracking changes to code and configuration over time. Git is the most common version control system.
+
+## Webhook
+An HTTP callback that sends data to a specified URL when an event occurs. Enables real-time integrations between systems.
+
+## YAML (YAML Ain't Markup Language)
+A human-friendly data serialization format commonly used for configuration files. More readable than JSON but with similar capabilities.

package/templates/addon-resources/resources/index.mdx

@@ -1,35 +1,86 @@
 ---
-sidebar_position: 1
-sidebar_class_name: sidebar-logo-sp-days
-pagination_next: null
+sidebar_label: Resources
+sidebar_position: 0
 ---
 
+{/*
+
+This is the main landing page for the Resources section. It provides an icon grid navigation 
+to help users quickly find the type of resource they need. Customize the icon grid with the 
+resource types most relevant to your content.
+
+*/}
+
 import {
 IconContainersSection,
 IconContainerBlock,
 } from "@sp-days-framework/docusaurus-frontpage-collection";
 
-# Resources Overview
+# Resources
+
+<IconContainersSection maxItemsPerRow="1">
+  <IconContainerBlock
+    title="Best Practice"
+    iconify="mdi:lightbulb-on-outline"
+    link="/resources/best-practice/"
+  />
+</IconContainersSection>
+
+## Available Templates {#available-templates style="text-align: center;"}
 
 <IconContainersSection maxItemsPerRow="2">
   <IconContainerBlock
-    title="Frontpage Collection"
-    iconify="mdi:code-block-tags"
-    link="/resources/frontpage-collection/"
+    title="API Reference"
+    iconify="mdi:api"
+    link="/resources/api-reference/"
   />
   <IconContainerBlock
-    title="Interactive Tasks"
-    iconify="ci:window-check"
-    link="/resources/interactive-tasks/"
+    title="Cheat Sheet"
+    iconify="mdi:notebook-outline"
+    link="/resources/cheat-sheet/"
   />
   <IconContainerBlock
-    title="Slidev Integration"
-    iconify="mdi:television-play"
-    link="/resources/slidev-integration/"
+    title="CLI Reference"
+    iconify="mdi:console"
+    link="/resources/cli-reference/"
   />
   <IconContainerBlock
-    title="Slidev SP Theme"
-    iconify="mdi:palette-outline"
-    link="/resources/sykehuspartner-theme/"
+    title="Configuration Guide"
+    iconify="mdi:tune"
+    link="/resources/configuration-guide/"
+  />
+  <IconContainerBlock
+    title="Environment Setup"
+    iconify="mdi:cog-outline"
+    link="/resources/environment-setup/"
+  />
+  <IconContainerBlock
+    title="FAQ"
+    iconify="mdi:help-circle-outline"
+    link="/resources/faq/"
+  />
+  <IconContainerBlock
+    title="Glossary"
+    iconify="mdi:book-alphabet"
+    link="/resources/glossary/"
+  />
+  <IconContainerBlock
+    title="Quick Start"
+    iconify="mdi:rocket-launch-outline"
+    link="/resources/quick-start/"
+  />
+  <IconContainerBlock
+    title="Troubleshooting"
+    iconify="mdi:wrench-outline"
+    link="/resources/troubleshooting/"
+  />
+  <IconContainerBlock
+    title="Useful Links"
+    iconify="mdi:link-variant"
+    link="/resources/useful-links/"
   />
 </IconContainersSection>
+
+:::tip Customize This Page
+Remove sections that don't apply to your technology and add new ones as needed.
+:::