Skip to content

Reduce CLAUDE.md to essentials with guide from claude.#201

Open
jklein24 wants to merge 1 commit intomainfrom
02-13-reduce_claude.md_to_essentials_with_guide_from_claude
Open

Reduce CLAUDE.md to essentials with guide from claude.#201
jklein24 wants to merge 1 commit intomainfrom
02-13-reduce_claude.md_to_essentials_with_guide_from_claude

Conversation

@jklein24
Copy link
Contributor

No description provided.

@jklein24 jklein24 requested a review from shreyav February 14, 2026 04:34
Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 14, 2026

Greptile Overview

Greptile Summary

Streamlined CLAUDE.md from 237 lines to 59 lines by removing verbose explanations and focusing on actionable essentials. The refactored version maintains critical information (Mintlify version pinning, Node.js requirements, OpenAPI bundling workflow) while improving scannability and reducing cognitive load.

Key improvements:

  • Condensed architecture details into a concise file structure tree
  • Moved verbose troubleshooting and CSS tips into compact, actionable bullets
  • Retained all critical rules and commands with clearer formatting
  • References mintlify/CLAUDE.md for detailed writing standards instead of duplicating them

Issue found:

  • Line 23 incorrectly states make lint lints markdown, but the underlying script doesn't exist

Confidence Score: 4/5

  • This PR is safe to merge with minimal risk - it's a documentation refactoring that improves clarity.
  • Documentation-only change that successfully condenses guidance without losing critical information. One minor inaccuracy in a command description (line 23) is easily fixable and doesn't affect functionality.
  • No files require special attention - the single syntax fix on line 23 is straightforward.

Important Files Changed

Filename Overview
CLAUDE.md Condensed from 237 to 59 lines, focusing on critical rules, commands, and troubleshooting. One minor inaccuracy in command description.

Last reviewed commit: 2734e75

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

make mint
make install # Install dependencies
make build # Bundle OpenAPI spec (openapi/ → openapi.yaml + mintlify/openapi.yaml)
make lint # Lint OpenAPI + markdown + run mint openapi-check
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description says make lint runs "Lint OpenAPI + markdown + run mint openapi-check", but the Makefile shows it only runs npm run lint (which is lint:openapi) and mint openapi-check. The lint:markdown script doesn't exist in package.json, so markdown linting isn't actually performed.

Suggested change
make lint # Lint OpenAPI + markdown + run mint openapi-check
make lint # Lint OpenAPI + run mint openapi-check
Prompt To Fix With AI
This is a comment left during a code review.
Path: CLAUDE.md
Line: 23:23

Comment:
The description says `make lint` runs "Lint OpenAPI + markdown + run mint openapi-check", but the Makefile shows it only runs `npm run lint` (which is `lint:openapi`) and `mint openapi-check`. The `lint:markdown` script doesn't exist in `package.json`, so markdown linting isn't actually performed.

```suggestion
make lint           # Lint OpenAPI + run mint openapi-check
```

How can I resolve this? If you propose a fix, please make it concise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant