derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
84 lines
2.4 KiB
Plaintext
84 lines
2.4 KiB
Plaintext
---
|
|
title: "Claude Code setup"
|
|
description: "Configure Claude Code for your documentation workflow"
|
|
icon: "asterisk"
|
|
---
|
|
|
|
Claude Code is Anthropic's official CLI tool. This guide will help you set up Claude Code to help you write and maintain your documentation.
|
|
|
|
## Prerequisites
|
|
|
|
- Active Claude subscription (Pro, Max, or API access)
|
|
|
|
## Setup
|
|
|
|
1. Install Claude Code globally:
|
|
|
|
```bash
|
|
npm install -g @anthropic-ai/claude-code
|
|
```
|
|
|
|
2. Navigate to your docs directory.
|
|
3. (Optional) Add the `CLAUDE.md` file below to your project.
|
|
4. Run `claude` to start.
|
|
|
|
## Create `CLAUDE.md`
|
|
|
|
Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards:
|
|
|
|
```markdown
|
|
# Mintlify documentation
|
|
|
|
## Working relationship
|
|
|
|
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
|
|
- ALWAYS ask for clarification rather than making assumptions
|
|
- NEVER lie, guess, or make up information
|
|
|
|
## Project context
|
|
|
|
- Format: MDX files with YAML frontmatter
|
|
- Config: docs.json for navigation, theme, settings
|
|
- Components: Mintlify components
|
|
|
|
## Content strategy
|
|
|
|
- Document just enough for user success - not too much, not too little
|
|
- Prioritize accuracy and usability of information
|
|
- Make content evergreen when possible
|
|
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
|
|
- Check existing patterns for consistency
|
|
- Start by making the smallest reasonable changes
|
|
|
|
## Frontmatter requirements for pages
|
|
|
|
- title: Clear, descriptive page title
|
|
- description: Concise summary for SEO/navigation
|
|
|
|
## Writing standards
|
|
|
|
- Second-person voice ("you")
|
|
- Prerequisites at start of procedural content
|
|
- Test all code examples before publishing
|
|
- Match style and formatting of existing pages
|
|
- Include both basic and advanced use cases
|
|
- Language tags on all code blocks
|
|
- Alt text on all images
|
|
- Relative paths for internal links
|
|
|
|
## Git workflow
|
|
|
|
- NEVER use --no-verify when committing
|
|
- Ask how to handle uncommitted changes before starting
|
|
- Create a new branch when no clear branch exists for changes
|
|
- Commit frequently throughout development
|
|
- NEVER skip or disable pre-commit hooks
|
|
|
|
## Do not
|
|
|
|
- Skip frontmatter on any MDX file
|
|
- Use absolute URLs for internal links
|
|
- Include untested code examples
|
|
- Make assumptions - always ask for clarification
|
|
```
|