Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .claude/settings.local.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"permissions": {
"allow": [
"WebFetch(domain:github.com)",
"WebFetch(domain:www.npmjs.com)",
"Read(//c/Users/mufa/documents/developer-documentation/$APPDATA/Claude/**)",
"Read(//c/Users/mufa/documents/developer-documentation/$HOME/AppData/Roaming/Claude/**)",
"Bash(claude mcp:*)",
"Bash(python3 -c \"import json,sys; d=json.load\\(sys.stdin\\); print\\(json.dumps\\(list\\(d.keys\\(\\)\\), indent=2\\)\\)\")",
"Bash(python3:*)",
"mcp__exasol_db__list_schemas",
"mcp__exasol_db__list_tables",
"Read(//c/Users/mufa/.claude/skills//**)",
"Read(//c/Users/mufa/.claude//**)",
"Bash(mkdir -p /c/Users/mufa/.claude/skills/exasol-developer-guide-creator)",
"Bash(mv /c/Users/mufa/.claude/skills/exasol-explore /c/Users/mufa/.claude/skills/exasol-developer-guide-creator/)",
"Bash(mv /c/Users/mufa/.claude/skills/exasol-new /c/Users/mufa/.claude/skills/exasol-developer-guide-creator/)",
"Bash(mv /c/Users/mufa/.claude/skills/exasol-modify /c/Users/mufa/.claude/skills/exasol-developer-guide-creator/)",
"Bash(mv /c/Users/mufa/.claude/skills/exasol-implement /c/Users/mufa/.claude/skills/exasol-developer-guide-creator/)"
]
}
}
91 changes: 91 additions & 0 deletions .claude/skills/exasol-explore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Exasol Developer Guide — Explore & Audit

Crawl the existing developer guide, surface improvement opportunities, and co-create an action plan with the user through interactive Q&A.

---

## Context

- **Project path:** `C:\Users\mufa\documents\developer-documentation`
- **Docs root:** `doc/`
- **File format:** reStructuredText (`.rst`) rendered by Sphinx
- **Target audience:** Data professionals and developers — professional but accessible
- **Gold standard sections:** `doc/connect_to_exasol/` and `doc/gen_ai/ai_text_summary/`

---

## Step 1 — Explore the Project

Read the following in parallel using Glob and Read tools:
- Full folder/file tree of `doc/` (use Glob with `doc/**/*`)
- `doc/index.rst` — top-level toctree
- Every `index.rst` inside section subfolders
- 2–3 representative content files per section (pick the most substantial ones)

Do NOT skip any section folder. Read actual file contents, not just filenames.

---

## Step 2 — Assess Each Section

Evaluate every section against the developer guide standard:

**Expected structure per section:**
1. **What** — Clear definition: what the feature/tool is, why it exists
2. **How** — Step-by-step implementation with working, copy-paste-ready code examples
3. **Benefits + Real-world use cases** — Practical scenarios, when to use it, what it enables

**Quality checklist per section:**
- Is the tone professional but accessible? Not overwhelming, not condescending.
- Are prerequisites clearly stated before any steps?
- Are code examples present and complete (not just snippets)?
- Is information up to date (no outdated version references)?
- Are there cross-references to related sections?
- Is complexity appropriate — does it avoid dumping advanced detail on beginners?
- Does it follow the What → How → Benefits structure?

---

## Step 3 — Interactive Q&A

Present your findings to the user in this structure:

**1. Current state**
Table or list of all sections with a brief quality rating (Good / Needs Work / Incomplete / Missing).

**2. Gaps identified**
Features or tools that exist in the Exasol ecosystem but have no section yet.

**3. Specific improvement areas**
Be concrete — e.g., "UDF/debugging.rst is only one sentence, needs a real debugging walkthrough" or "connect_to_exasol/connection.rst has no error handling example."

**4. Ranked suggestions**
List improvements ordered by impact (high / medium / low).

Then ask the user targeted questions to understand priorities:
- Which of these improvements matters most right now?
- Are there specific features or connectors they want to document next?
- Any sections they want to fully restructure vs. just expand?
- Anything they want to remove or consolidate?

Wait for user responses before proceeding.

---

## Step 4 — Sketch the Plan

Based on the Q&A responses, produce a concrete action plan:

For each proposed change, state:
- Section name and file(s) affected
- Type of change: **new section** / **add content** / **restructure** / **simplify**
- Brief description of what will change and why
- Priority: High / Medium / Low

Group by priority. Note which changes can be directly executed with `/exasol-implement` (content additions, modifications) versus which need a planning session first with `/exasol-new` (entirely new sections) or `/exasol-modify` (structural overhaul).

---

## Important

Do NOT write any files during this skill. This skill is exploration and planning only.
188 changes: 188 additions & 0 deletions .claude/skills/exasol-implement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
# Exasol Developer Guide — Implement

Write RST files to disk based on a plan produced by `/exasol-new` or `/exasol-modify`.

## Prerequisites

A plan **must already exist** in this conversation from running `/exasol-new` or `/exasol-modify`.
If no plan is present, respond: "No plan found. Please run `/exasol-new` or `/exasol-modify` first."

---

## Context

- **Project path:** `C:\Users\mufa\documents\developer-documentation`
- **Docs root:** `doc/`
- **File format:** reStructuredText (`.rst`) rendered by Sphinx
- **Target audience:** Data professionals and developers — professional but accessible
- **Standard structure:** What → How (step-by-step with code) → Benefits + Real-world use cases + Examples

---

## Step 1 — Confirm

Summarise what will be written or modified based on the plan. List:
- Files to be created (with paths)
- Files to be modified (with paths)
- Toctree entries to be added

Ask: "Ready to implement — shall I proceed?"

Wait for confirmation before writing anything.

---

## Step 2 — Implement Each File

Write or edit each file according to the plan. Strictly follow the RST conventions below.

---

### RST Formatting Rules

#### Heading Levels

```rst
===================
Document Title (H1)
===================

Section Heading (H2)
====================

Subsection Heading (H3)
-----------------------

Sub-subsection (H4)
^^^^^^^^^^^^^^^^^^^
```

- H1 (document title): overline AND underline with `=`
- H2 (major sections): underline only with `=`
- H3 (subsections): underline with `-`
- H4 (sub-subsections): underline with `^`
- The overline/underline must be **at least as long as the text**

#### Code Blocks

```rst
.. code-block:: python

import pyexasol
connection = pyexasol.connect(dsn='host:port', user='sys', password='exasol')
```

Always specify the language: `python`, `sql`, `bash`, `text`, `json`.
Indent code content by **4 spaces** inside the directive.

#### Notes and Warnings

```rst
.. note::
Text here, indented 3 spaces.

.. warning::
Text here.

.. important::
Text here.
```

#### Tables

```rst
.. list-table:: Optional Title
:header-rows: 1
:widths: 25 75

* - Column One
- Column Two
* - Row value
- Row value
```

#### Links

```rst
`Link text <https://url>`_
```

#### Internal Cross-References

```rst
.. _my-label:

Section Title
=============

(elsewhere in the docs)
:ref:`my-label`
```

#### Toctree

```rst
.. toctree::
:maxdepth: 2

overview
installation
usage
subdir/index
```

Do NOT include `.rst` extension in toctree entries (Sphinx convention — omit the extension).

#### Bold, Italic, Inline Code

```rst
**bold text**
*italic text*
``inline code``
```

---

### Content Standards

- **Tone:** Professional but accessible. Not overwhelming, not condescending.
- **Every "How" section** must have at least one working, copy-paste ready code example.
- **Prerequisites** must appear before any step-by-step instructions.
- **Structure:** Follow What → How → Benefits + Real-world examples for every section.
- **Sections stay focused** — avoid walls of text; split into subsections if content exceeds ~60 lines.
- **Cross-references:** Add `:ref:` links to related sections in the guide where relevant.
- **External links:** Use real URLs from the research in `/exasol-new` or `/exasol-modify`. Never invent URLs.
- **Code examples** should use realistic but simple values (e.g., schema name `DEMO`, table `EMPLOYEES`).

---

## Step 3 — Update Toctrees

### New section folder created:
1. Read `doc/index.rst`
2. Add the new entry to the toctree at the position specified in the plan
3. Write the updated `doc/index.rst`

### New file added to existing section:
1. Read the section's `index.rst`
2. Add the new filename (without `.rst`) to the toctree in logical order
3. Write the updated `index.rst`

---

## Step 4 — Report

After all files are written, output a summary:

```
Files created:
doc/[section]/index.rst
doc/[section]/overview.rst
...

Files modified:
doc/index.rst (added toctree entry: [section]/index)
...
```

If anything in the plan was unclear or could not be fully implemented, note it so the user can follow up.
Loading
Loading