Skip to content

docs: weekly update 2026-11-20, Analysis CLI init --auto default [OD-1173] - #2831

Closed
claudiacodacy wants to merge 1 commit into
masterfrom
docs/weekly-2026-11-20
Closed

claudiacodacy wants to merge 1 commit into
masterfrom
docs/weekly-2026-11-20

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

Weekly docs update for what team Odin shipped to production between 2026-11-13 and 2026-11-20.

Changes

init --auto default selection (OD-1173)

  • Code read: codacy/analysis-cli#166 (dc711d1ff) and codacy/analysis-cli#174 (27cc6e2bb). Both shipped in @codacy/analysis-cli@0.31.0, published to npm on 2026-11-18. packages/runner/src/init.ts checked at 1bbb11f82, and filter names checked against the CLI README.
  • Page edited: docs/codacy-analysis-cli/index.md, section "If your repository isn't on Codacy":
    • With no filter, init --auto leaves out Minor patterns in the Code style and Documentation categories.
    • Any filter replaces that default. The page adds an example that selects every severity.
    • init --auto doesn't select markdownlint or Agentlinter unless the repository has its own configuration file for that tool.

TODO markers

None.

Checks

  • mkdocs build --strict: passed.
  • vale docs/codacy-analysis-cli/index.md: no findings on the added lines. The 12 findings elsewhere on the page were there before this change and are left alone.
  • Investigation checks:
    • Lockstep: the page has no <!--NOTE comment.
    • Includes: the changed text isn't in a shared include.
    • Anchors: no heading changed.
    • Self-hosted: not applicable.
  • The Guardrails getting-started page also uses init --auto but doesn't describe its default, so it isn't changed.

Not in this PR

  • update-config on a configuration made by init --auto now removes the patterns and tools this default leaves out (0.31.0 release notes). The "Keep the configuration current" section doesn't say this yet. It's left out to keep the diff small. Reviewers can decide whether to add it.

🤖 Generated with Claude Code

…rkdownlint by default [OD-1173]

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Overall readability score: 54.64 (🟢 +0)

File Readability
index.md 68.31 (🟢 +0.23)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 68.31 53 9.75 10.7 9.8 6.55
  🟢 +0.23 🟢 +0.1 🟢 +0.03 🟢 +0 🟢 +0.18 🔴 -0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.64 43.05 10.78 12.26 12.3 7.94
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

This branch was successfully deployed

1 active deployment
Netlify — 54cc7e23 Deployed Nov 20, 2026 by github-actions[bot]
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