Skip to content

Commit 6013654

Browse files
authored
Merge branch 'master' into patch-2
2 parents 948d348 + 8e0211e commit 6013654

File tree

195 files changed

+14506
-7292
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

195 files changed

+14506
-7292
lines changed

.context/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Context Files for LLMs and AI Tools
2+
3+
This directory contains plans, reports, and other context files that are:
4+
- Used to provide context to LLMs during development
5+
- Not committed to the repository
6+
- May be transient or belong in other repositories
7+
8+
## Directory Structure
9+
10+
- `plans/` - Documentation plans and roadmaps
11+
- `reports/` - Generated reports and analyses
12+
- `research/` - Research notes and findings
13+
- `templates/` - Reusable templates for Claude interactions
14+
15+
## Usage
16+
17+
Place files here that you want to reference--for example, using @ mentions in Claude--such as:
18+
- Documentation planning documents
19+
- API migration guides
20+
- Performance reports
21+
- Architecture decisions
22+
23+
## Example Structure
24+
25+
```
26+
.context/
27+
├── plans/
28+
│ ├── v3.2-release-plan.md
29+
│ └── api-migration-guide.md
30+
├── reports/
31+
│ ├── weekly-progress-2025-07.md
32+
│ └── pr-summary-2025-06.md
33+
├── research/
34+
│ └── competitor-analysis.md
35+
└── templates/
36+
└── release-notes-template.md
37+
```
38+
39+
## Best Practices
40+
41+
1. Use descriptive filenames that indicate the content and date
42+
2. Keep files organized in appropriate subdirectories
43+
3. Consider using date prefixes for time-sensitive content (e.g., `2025-07-01-meeting-notes.md`)
44+
4. Remove outdated files periodically to keep the context relevant

.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`.

0 commit comments

Comments
 (0)