Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit8799e23

Browse files
starting to set up for proper api docs
starting to set up for proper api docsadded openapi.json for testing
1 parent30a3409 commit8799e23

File tree

5 files changed

+25159
-241
lines changed

5 files changed

+25159
-241
lines changed

‎CLAUDE.md‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
66

77
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.
88

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+
914
##Common Development Commands
1015

1116
###Local Development
@@ -37,26 +42,16 @@ Since this is a documentation site, there are no test commands or build processe
3742

3843
###Content Organization
3944

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
43-
-`/docs/Managing-Datasets/` - Dataset operations (save, share, export, metadata management)
44-
-`/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-
5145
**Documentation Structure**: Content is organized hierarchically with clear navigation paths and consistent file naming conventions.
5246

5347
###Content Standards & Patterns
5448

5549
**Front Matter Structure** (based on established documentation standards):
5650
```yaml
5751
---
58-
title:"Page Title"# Full descriptive title
52+
title:"Page Title"# Fullclear,descriptive title
5953
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)
6055
---
6156
```
6257

@@ -134,7 +129,6 @@ The repository includes extensive custom styling in `styles.css` with:
134129
- always use active voice unless**absolutely** unavoidable. that includes preferring opening sentences with active simple present tense instead of gerunds.
135130
- 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.
136131
- 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
138132

139133
##Visual Layer Documentation Standards
140134

@@ -176,9 +170,9 @@ The repository includes extensive custom styling in `styles.css` with:
176170
- Legacy fastdup documentation maintained in separate configuration
177171
- 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.
178172
- lists with more than 2 items should always use unordered lists even if they also make sense as part of prose paragraphs.
179-
- <Frame>
173+
-`<Frame>`
180174
<imgsrc="/images/highlight-filters-and-insights.png" />
181-
</Frame> this is the way to wrap images always
175+
`</Frame>` this is the way to wrap images always
182176

183177
#Mintlify documentation
184178

@@ -203,9 +197,16 @@ The repository includes extensive custom styling in `styles.css` with:
203197

204198
- Refer to the[docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation
205199

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:
202+
https://www.mintlify.com/docs/guides/migrating-from-mdx.md
203+
https://www.mintlify.com/docs/api-playground/overview
204+
https://www.mintlify.com/docs/api-playground/openapi-setup
205+
https://www.mintlify.com/docs/api-playground/managing-page-visibility
206+
https://www.mintlify.com/docs/api-playground/multiple-responses
207+
https://www.mintlify.com/docs/api-playground/mdx-setup
208+
209+
209210

210211
##Writing standards
211212
- Second-person voice ("you")
@@ -226,7 +227,7 @@ The repository includes extensive custom styling in `styles.css` with:
226227
- NEVER skip or disable pre-commit hooks
227228

228229
##Do not
229-
-Skip frontmatter on any MDX file
230-
-Use absolute URLs for internal links
231-
-Include untested code examples
232-
- Make assumptions - always ask for clarification
230+
-NEVER skip frontmatter on any MDX file
231+
-NEVER use absolute URLs for internal links
232+
-NEVER include untested code examples
233+
- Make assumptions - always ask for clarification!!!!

‎api-reference/openapi.json‎

Lines changed: 0 additions & 217 deletions
This file was deleted.

‎docs/Creating-Datasets/importing-annotations/bounding-box.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title:"Bounding Box Visual Layer Format"
3-
sidebarTitle:"Boundingbox format"
3+
sidebarTitle:"BoundingBox Format"
44
description:"Learn Visual Layer's bounding box CSV format and compare it to COCO, PASCAL VOC, YOLO, and other common formats."
55
---
66
##Overview

‎docs/Creating-Datasets/importing-annotations/preparing-annotation-data-file.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title:"Preparing Annotation File"
3-
sidebarTitle:"Preparefile"
3+
sidebarTitle:"PrepareFile"
44
description:"Structure annotation files correctly for Visual Layer using COCO JSON or CSV formats to prevent import errors."
55
---
66

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp