You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLAUDE.md
+23-22Lines changed: 23 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,11 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
6
6
7
7
This is the**Visual Layer Documentation Website** - a comprehensive documentation platform built with Mintlify for Visual Layer's computer vision and dataset management platform. The repository contains technical documentation, API references, deployment guides, and user manuals for Visual Layer's visual dataset analysis platform.
8
8
9
+
##The most important rules
10
+
- Always ask if you're not sure and NEVER assume
11
+
- Always align with the conventions, guidelines, standards, style tone & voice we've established in this guide
12
+
- Always consult with mintlify docs if you you're not sure on structure, syntax, etc.
13
+
9
14
##Common Development Commands
10
15
11
16
###Local Development
@@ -37,26 +42,16 @@ Since this is a documentation site, there are no test commands or build processe
37
42
38
43
###Content Organization
39
44
40
-
**Main Documentation Sections**:
41
-
-`/docs/getting-started/` - Introduction, quick start guides, and platform orientation
42
-
-`/docs/Creating-Datasets/` - Dataset creation, annotation import, and custom metadata
-`/docs/Exploring-datasets/` - Search, filtering, quality analysis, and data exploration
45
-
-`/docs/Dataset-Enrichment/` - AI model-based data enhancement and analysis
46
-
-`/docs/on-prem/` - On-premises installation and configuration guides
47
-
-`/docs/Integrations/` - External service integrations (S3, GCS, etc.)
48
-
-`/api-reference/` - REST API documentation with authentication and endpoints
49
-
-`/changelog/` - Release notes and version history
50
-
51
45
**Documentation Structure**: Content is organized hierarchically with clear navigation paths and consistent file naming conventions.
52
46
53
47
###Content Standards & Patterns
54
48
55
49
**Front Matter Structure** (based on established documentation standards):
56
50
```yaml
57
51
---
58
-
title:"Page Title"# Full descriptive title
52
+
title:"Page Title"# Fullclear,descriptive title
59
53
description:"Brief description"# SEO and page description
54
+
sidebar:"Page Title Shortened if Necessary"# Page title shortened to 20 characters maximum (not shortened if not necessary)
60
55
---
61
56
```
62
57
@@ -134,7 +129,6 @@ The repository includes extensive custom styling in `styles.css` with:
134
129
- always use active voice unless**absolutely** unavoidable. that includes preferring opening sentences with active simple present tense instead of gerunds.
135
130
- never use "please" and never use i.e. nor e.g. Only "For example" or "Example:". And always use correct punctuation including periods - even when in ordered lists.Finally, every article must ALWAYS open with an introduction - even if minimal.
136
131
- never use divider lines in the middle of articles unless you consult with me before starting.
137
-
- exception to title case for titles and headings: ensure that sidebarTitle always use sentence case and is always limited to 20 chars at most. This means that sometimes longer title needs to be shortened only for the sidebarTitle
138
132
139
133
##Visual Layer Documentation Standards
140
134
@@ -176,9 +170,9 @@ The repository includes extensive custom styling in `styles.css` with:
176
170
- Legacy fastdup documentation maintained in separate configuration
177
171
- for sections with subsections, there should never be any concluding or summary paragraphs at the end of the last subsection that are related to summaries of the entire main section. instead, all summaries, conclusions, etc. should be part of the intro to the main section.
178
172
- lists with more than 2 items should always use unordered lists even if they also make sense as part of prose paragraphs.
@@ -203,9 +197,16 @@ The repository includes extensive custom styling in `styles.css` with:
203
197
204
198
- Refer to the[docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation
205
199
206
-
##Frontmatter requirements for pages
207
-
- title: Clear, descriptive page title
208
-
- description: Concise summary for SEO/navigation
200
+
##API documentation
201
+
Always consult with the following support articles from Mintlify if necessary to ensure structure, and integrity of content. Following are the primary but NOT the ONLY pages that you should consult with: