Skip to content

Commit 38b08ec

Browse files
committed
chore(qol): Add claude instructions file for the project
The CLAUDE.md file successfully references 5 key files, all of which exist and are accessible: 1. @README → README.md - Project overview and setup 2. @package.json → package.json - NPM scripts and dependencies 3. @.github/copilot-instructions.md → Main style guidelines and product info 4. @.github/instructions/contributing.instructions.md → Detailed contributing guide 5. @.github/instructions/influxdb3-code-placeholders.instructions.md → InfluxDB 3 specific guidelines 📊 Current Structure Analysis The CLAUDE.md file acts as a minimal index that: - Delegates detailed instructions to other files - Uses Claude's @ symbol notation for file references - Provides a clear hierarchy of information 💡 Key Instructions Coverage Through the linked files, Claude has access to: - Product documentation paths for all InfluxDB versions - Style guidelines following Google Developer Documentation standards - Shortcode usage with extensive examples - Testing procedures including pytest-codeblocks - Development workflows with Docker and Node.js - Placeholder conventions for code examples - Frontmatter requirements for Hugo pages
1 parent a85eb32 commit 38b08ec

File tree

3 files changed

+49
-6
lines changed

3 files changed

+49
-6
lines changed

.github/copilot-instructions.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
# GitHub Copilot Instructions for InfluxData Documentation
1+
# Instructions for InfluxData Documentation
22

33
## Purpose and scope
44

5-
GitHub Copilot should help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting.
5+
Help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting.
66

77
## Documentation structure
88

99
- **Product version data**: `/data/products.yml`
10-
- **Products**:
10+
- **InfluxData products**:
11+
- InfluxDB 3 Explorer
12+
- Documentation source path: `/content/influxdb3/explorer`
13+
- Published for the web: https://docs.influxdata.com/influxdb3/explorer/
1114
- InfluxDB 3 Core
1215
- Documentation source path: `/content/influxdb3/core`
1316
- Published for the web: https://docs.influxdata.com/influxdb3/core/
@@ -92,7 +95,8 @@ GitHub Copilot should help document InfluxData products by creating clear, accur
9295

9396
## Markdown and shortcodes
9497

95-
- Include proper frontmatter for each page:
98+
- Include proper frontmatter for Markdown pages in `content/**/*.md` (except for
99+
shared content files in `content/shared/`):
96100

97101
```yaml
98102
title: # Page title (h1)
@@ -180,3 +184,17 @@ Table: keys: [_start, _stop, _field, _measurement]
180184
## Related repositories
181185

182186
- **Internal documentation assistance requests**: https://github.com/influxdata/DAR/issues Documentation
187+
188+
## Additional instruction files
189+
190+
For specific workflows and content types, also refer to:
191+
192+
- **InfluxDB 3 code placeholders**: `.github/instructions/influxdb3-code-placeholders.instructions.md` - Guidelines for placeholder formatting, descriptions, and shortcode usage in InfluxDB 3 documentation
193+
- **Contributing guidelines**: `.github/instructions/contributing.instructions.md` - Detailed style guidelines, shortcode usage, frontmatter requirements, and development workflows
194+
- **Content-specific instructions**: Check `.github/instructions/` directory for specialized guidelines covering specific documentation patterns and requirements
195+
196+
## Integration with specialized instructions
197+
198+
When working on InfluxDB 3 documentation (Core/Enterprise), prioritize the placeholder guidelines from `influxdb3-code-placeholders.instructions.md`.
199+
200+
For general documentation structure, shortcodes, and development workflows, follow the comprehensive guidelines in `contributing.instructions.md`.

CLAUDE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Instructions for InfluxData Documentation
2+
3+
## Purpose and scope
4+
5+
Claude should help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting.
6+
7+
## Project overview
8+
9+
See @README.md
10+
11+
## Available NPM commands
12+
13+
@package.json
14+
15+
## Instructions for contributing
16+
17+
See @.github/copilot-instructions.md for style guidelines and
18+
product-specific documentation paths and URLs managed in this project.
19+
20+
See @.github/instructions/contributing.instructions.md for contributing
21+
information including using shortcodes and running tests.
22+
23+
See @.github/instructions/influxdb3-code-placeholders.instructions.md for using
24+
placeholders in code samples and CLI commands.
25+

build-scripts/build-copilot-instructions.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ function buildContributingInstructions() {
4646
applyTo: "content/**/*.md, layouts/**/*.html"
4747
---
4848
49-
# GitHub Copilot Instructions for InfluxData Documentation
49+
# Contributing instructions for InfluxData Documentation
5050
5151
## Purpose and scope
5252
53-
GitHub Copilot should help document InfluxData products
53+
Help document InfluxData products
5454
by creating clear, accurate technical content with proper
5555
code examples, frontmatter, shortcodes, and formatting.
5656

0 commit comments

Comments
 (0)