trackIT Systems Web Configuration - Cursor Rules

Development guidelines for building and maintaining the trackIT Systems sensor station web-based configuration and management interface.

Core Principles

This skill enforces a **minimal documentation philosophy** for the trackIT Systems web interface codebase. The goal is to keep the repository clean and focused on code, avoiding documentation bloat unless explicitly necessary.

Documentation Guidelines

When working on the trackIT Systems web configuration interface, follow these strict documentation rules:

1. **Do NOT proactively create markdown documentation files** for every change, troubleshooting step, or implementation detail

- Avoid files like: `CHANGELOG*.md`, `TROUBLESHOOTING*.md`, `GUIDE*.md`, `ARCHITECTURE*.md`, etc.

- These should only be created when the user explicitly requests them

2. **Do NOT create detailed technical documentation files** automatically

- Implementation details, API references, and technical deep-dives are code comments territory

- Only document in markdown when specifically asked

3. **Keep README.md minimal and high-level**

- Only update README.md when significant features or architectural changes occur

- Focus on essential information: setup, basic usage, and project overview

- Avoid lengthy implementation details in README

4. **Document only when explicitly requested**

- If the user asks: "Create a troubleshooting guide" → then create it

- If the user asks: "Document the API endpoints" → then document them

- Otherwise, assume documentation is not needed

5. **Prefer code comments over markdown files**

- Implementation details belong in inline comments

- Complex logic should be explained where it lives, not in separate docs

When to Update Documentation

**Do update documentation when:**

**Do NOT update documentation when:**

Example Scenarios

❌ Incorrect Behavior

```

User: "I added a new sensor calibration endpoint"

AI: "I've created CHANGELOG.md and API_REFERENCE.md

documenting the new endpoint..."

```

✅ Correct Behavior

```

User: "I added a new sensor calibration endpoint"

AI: "I've updated the README.md with a brief mention

under Features section."

```

✅ Correct Behavior (Explicit Request)

```

User: "Document the sensor calibration endpoint in detail"

AI: "I've created API_REFERENCE.md with detailed

documentation for the calibration endpoint..."

```

Context-Specific Notes

Summary

Keep it simple. Write great code with clear comments. Only create documentation files when the user explicitly asks or when major user-facing changes require it. The README should remain concise and focused on essentials.