docs: update documentation to reflect optional RulesPath

[oshorefueled]

• README.md: Simplify Quick Start to 3 steps using bundled preset
• README.md: Remove manual rule creation step (now uses VectorLint preset)
• README.md: Update terminology from 'Global API keys' to 'LLM provider API keys'
• CONFIGURATION.md: Mark RulesPath as optional in settings table
• CONFIGURATION.md: Update example to show RulesPath commented out
• init-command.ts: Reorder next steps to prioritize API key setup

Summary by CodeRabbit

• Documentation
  • Clarified that RulesPath is optional and bundled preset rules are used by default.
  • Simplified Quick Start to emphasize "Run a check" with bundled presets before creating custom rules; removed the previous rule-creation example.
  • Updated wording for app config to reference LLM provider API keys and settings.
• UX / Messaging
  • Refined init command next-step guidance to focus on configuring API keys and running your first lint check.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation and CLI messaging were updated: RulesPath is no longer required, examples and quick-start flow were simplified to emphasize bundled presets and running a check, and post-init instructions now point users to configure API keys, run linting, or optionally edit local rules.

Changes

Cohort / File(s)	Summary
Configuration doc CONFIGURATION.md	Changed RulesPath from required to optional; updated example and global settings table to reflect omission uses bundled presets and adjusted default description.
README / Quick Start README.md	Removed "Create Your First Rule" example and reworked Quick Start to show "Run a check" using doc.md; noted bundled preset and relocated link to creating custom rules.
CLI messaging src/cli/init-command.ts	Updated post-init success/next-steps text to direct users to open global config for API keys, run vectorlint <file> to lint, and optionally edit local config for custom rules; no functional logic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• hurshore

Poem

🐇 I hopped through docs and tweaked a line,
RulesPath optional — presets align.
Run a check, set keys, or craft a rule,
A small change today, keeping starts so cool.

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: updating documentation to reflect that RulesPath is now optional. This aligns with changes across CONFIGURATION.md, README.md, and init-command.ts.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 18c1cd7 and 33e4cc3.

📒 Files selected for processing (1)

• CONFIGURATION.md

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-12-28T19:43:51.189Z

Learnt from: CR
Repo: TRocket-Labs/vectorlint PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T19:43:51.189Z
Learning: Applies to .vectorlint.ini : Use `[glob/pattern]` sections in `.vectorlint.ini` to specify which packs run on which files

Applied to files:

• CONFIGURATION.md

📚 Learning: 2025-12-28T19:43:51.189Z

Learnt from: CR
Repo: TRocket-Labs/vectorlint PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T19:43:51.189Z
Learning: Organize rules into subdirectories (packs) within RulesPath; use company names (e.g., Acme, TechCorp, Stripe) to indicate which style guide the rules implement

Applied to files:

• CONFIGURATION.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

src/cli/init-command.ts (1)

67-69: Consider alignment with README.md example.

The CLI guidance uses a placeholder <file.md> while README.md uses the concrete example doc.md. For consistency and clarity, consider either:

• Using the same concrete example doc.md here, or
• Ensuring the README also uses angle-bracket placeholders

The current approach is functional but could momentarily confuse users cross-referencing documentation.

🔎 Suggested alignment with README.md

-            console.log(`  2. Run 'vectorlint <file.md>' to start linting your content`);
+            console.log(`  2. Run 'vectorlint doc.md' to start linting your content`);

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f8dded8 and 18c1cd7.

📒 Files selected for processing (3)

• CONFIGURATION.md
• README.md
• src/cli/init-command.ts

🧰 Additional context used

📓 Path-based instructions (1)

src/**/*.ts

📄 CodeRabbit inference engine (AGENTS.md)

src/**/*.ts: Use TypeScript ESM with explicit imports and narrow types
Use 2-space indentation; avoid trailing whitespace
Maintain strict TypeScript with no any; use unknown + schema validation for external data
Use custom error types with proper inheritance; catch blocks use unknown type

Files:

• src/cli/init-command.ts

🧠 Learnings (2)

📚 Learning: 2025-12-28T19:43:51.189Z

Learnt from: CR
Repo: TRocket-Labs/vectorlint PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T19:43:51.189Z
Learning: Organize rules into subdirectories (packs) within RulesPath; use company names (e.g., Acme, TechCorp, Stripe) to indicate which style guide the rules implement

Applied to files:

• CONFIGURATION.md

📚 Learning: 2025-12-28T19:43:51.189Z

Learnt from: CR
Repo: TRocket-Labs/vectorlint PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T19:43:51.189Z
Learning: Applies to .vectorlint.ini : Use `[glob/pattern]` sections in `.vectorlint.ini` to specify which packs run on which files

Applied to files:

• CONFIGURATION.md
• README.md

🧬 Code graph analysis (1)

src/cli/init-command.ts (2)

src/config/global-config.ts (1)

• getGlobalConfigPath (9-11)

src/config/constants.ts (1)

• DEFAULT_CONFIG_FILENAME (6-6)

🔇 Additional comments (3)

CONFIGURATION.md (1)

15-17: Clear guidance on optional RulesPath.

The updated comments effectively explain when to use or omit RulesPath, making the optional nature immediately clear to users.

README.md (2)

63-63: Improved terminology clarity.

The updated description "LLM provider API keys and settings" is more specific and descriptive than "Global API keys and provider settings," making the config file's purpose immediately clear.

---

79-87: Excellent simplification of the Quick Start flow.

The restructured step 3 significantly improves the getting-started experience by:

• Prioritizing immediate usage over configuration
• Leveraging the bundled preset to remove setup friction
• Maintaining clear pathways to customization

This aligns well with the PR's objective to make RulesPath optional and simplify onboarding.