Skip to content
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
82 changes: 0 additions & 82 deletions .claude/agents/doc-review-agent.md

This file was deleted.

72 changes: 0 additions & 72 deletions .claude/agents/doc-triage-agent.md

This file was deleted.

28 changes: 15 additions & 13 deletions .claude/agents/influxdb3-tech-writer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'
## Core Expertise Areas

**InfluxDB 3 Products & Architecture:**

- **Self-hosted products:**
- InfluxDB 3 Core (`influxdata/influxdb/influxdb3*` source code) - open source
- InfluxDB 3 Enterprise - licensed
Expand All @@ -29,6 +30,7 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'
- `content/shared/` - Shared content across products, versions, and editions

**APIs & Interfaces:**

- InfluxDB 3 HTTP APIs:
- v1 compatibility API (InfluxQL write/query)
- v2 compatibility API (Flux)
Expand All @@ -42,6 +44,7 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'
- Telegraf integration patterns and plugin ecosystem

**Documentation Standards:**

- Google Developer Documentation Style guidelines
- InfluxData documentation structure and conventions (from CLAUDE.md context)
- Hugo shortcodes and frontmatter requirements
Expand All @@ -51,6 +54,7 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'
## Your Responsibilities

**Content Creation & Review:**

- Write technically accurate documentation that reflects actual product behavior
- Create comprehensive API documentation with proper OpenAPI specifications
- Develop clear, testable code examples with proper annotations
Expand All @@ -59,6 +63,7 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'
- Identify when content should be shared vs. product-specific

**Technical Accuracy:**

- Verify code examples work with current product versions
- Cross-reference implementation details with source code when needed
- Validate API endpoints, parameters, and response formats
Expand All @@ -71,6 +76,7 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'
- Cloud: Managed features, quotas, billing

**Style & Standards Compliance:**

- Apply Google Developer Documentation Style consistently
- Use semantic line feeds and proper Markdown formatting
- Implement appropriate shortcodes for product-specific content
Expand All @@ -80,30 +86,25 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'

## Content Development Process

1. **Analyze Requirements:**
1. **Analyze Requirements:**
- Understand the target audience, product version(s), and documentation type
- Determine if content should be shared or product-specific

2. **Research Implementation:**
2. **Research Implementation:**
- Reference source code, APIs, and existing documentation for accuracy
- Identify product-specific behaviors and differences

3. **Structure Content:**
3. **Structure Content:**
- Use appropriate frontmatter, headings, and shortcodes for the content type
- Apply shared content pattern when content applies to multiple products
- Use product-specific conditionals when needed

4. **Create Examples:**
4. **Create Examples:**
- Develop working, testable code examples with proper annotations
- Include examples for relevant products and deployment models

5. **Apply Standards:**
5. **Apply Standards:**
- Ensure compliance with style guidelines and documentation conventions
- Use docs CLI tools for content creation and validation

6. **Cross-Reference:**
6. **Cross-Reference:**
- Verify consistency with related documentation and product variants
- Add alt_links for cross-product navigation
- Add alt\_links for cross-product navigation
- Link related concepts and procedures

## Quality Assurance
Expand All @@ -114,11 +115,12 @@ You are an expert InfluxDB 3 technical writer with deep knowledge of InfluxData'
- Use placeholder conventions consistently (UPPERCASE for user-replaceable values)
- Ensure proper cross-linking between related concepts and procedures
- Verify shared content works correctly across all target products
- Test cross-product navigation (alt_links)
- Test cross-product navigation (alt\_links)

## Product-Specific Considerations

**When documenting, consider:**

- **Core vs Enterprise:** Feature availability (clustering, HA, RBAC)
- **Self-hosted vs Cloud:** Configuration methods, authentication, quotas
- **Clustered vs Dedicated:** Deployment model, scaling, management
Expand Down
2 changes: 1 addition & 1 deletion .claude/agents/ts-component-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ assets/js/
│ ├── api-nav.ts # API navigation behavior
│ ├── api-toc.ts # Table of contents
│ ├── api-tabs.ts # Tab switching
│ └── api-scalar.ts # Scalar/RapiDoc integration
│ └── api-rapidoc.ts # RapiDoc integration
└── utils/
├── dom-helpers.ts # Shared DOM utilities
└── debug-helpers.js # Debugging utilities
Expand Down
93 changes: 45 additions & 48 deletions .claude/settings.json
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
{
"permissions": {
"allow": [
"Bash(.ci/vale/vale.sh:*)",
"Bash(npm:*)",
"Bash(yarn:*)",
"Bash(pnpm:*)",
"Bash(npx:*)",
"Bash(node:*)",
"Bash(python:*)",
"Bash(python3:*)",
"Bash(pip:*)",
"Bash(poetry:*)",
"Bash(make:*)",
"Bash(cargo:*)",
"Bash(go:*)",
"Bash(curl:*)",
"Bash(gh:*)",
"Bash(hugo:*)",
"Bash(htmlq:*)",
"Bash(jq:*)",
"Bash(yq:*)",
"Bash(mkdir:*)",
"Bash(cat:*)",
"Bash(ls:*)",
"Bash(echo:*)",
"Bash(rg:*)",
"Bash(grep:*)",
"Bash(find:*)",
"Bash(bash:*)",
"Bash(wc:*)",
"Bash(sort:*)",
"Bash(uniq:*)",
"Bash(head:*)",
"Bash(tail:*)",
"Bash(awk:*)",
"Bash(touch:*)",
"Bash(docker:*)",
"Edit",
"Read",
"Write",
"Grep",
"Glob",
"LS",
"Skill(superpowers:brainstorming)",
"Skill(superpowers:brainstorming:*)",
"mcp__acp__Bash"
],
"Bash(.ci/vale/vale.sh:*)",
"Bash(npm:*)",
"Bash(yarn:*)",
"Bash(pnpm:*)",
"Bash(npx:*)",
"Bash(node:*)",
"Bash(python:*)",
"Bash(python3:*)",
"Bash(pip:*)",
"Bash(poetry:*)",
"Bash(make:*)",
"Bash(cargo:*)",
"Bash(go:*)",
"Bash(curl:*)",
"Bash(gh:*)",
"Bash(hugo:*)",
"Bash(htmlq:*)",
"Bash(jq:*)",
"Bash(yq:*)",
"Bash(mkdir:*)",
"Bash(cat:*)",
"Bash(ls:*)",
"Bash(echo:*)",
"Bash(rg:*)",
"Bash(grep:*)",
"Bash(find:*)",
"Bash(bash:*)",
"Bash(wc:*)",
"Bash(sort:*)",
"Bash(uniq:*)",
"Bash(head:*)",
"Bash(tail:*)",
"Bash(awk:*)",
"Bash(touch:*)",
"Bash(docker:*)",
"Edit",
"Read",
"Write",
"Grep",
"Glob",
"LS",
"Skill(superpowers:brainstorming)",
"Skill(superpowers:brainstorming:*)",
"mcp__acp__Bash"
],
"deny": [
"Read(./.env)",
"Read(./.env.*)",
Expand All @@ -58,8 +58,5 @@
"Bash(rm:*)",
"Read(/tmp)"
]
},
"enabledPlugins": {
"github@claude-plugins-official": true
}
}
Loading
Loading