Skip to content

docs: document alcops.json discovery and streamline central config - #180

Merged
Arthurvdv merged 1 commit into
mainfrom
docs/document-alcops-json-discovery
Sep 9, 2026
Merged

Arthurvdv merged 1 commit into
mainfrom
docs/document-alcops-json-discovery

Conversation

@Arthurvdv

Copy link
Copy Markdown
Member

Summary

Documents how alcops.json is located and clarifies how it relates to central configuration. Addresses ALCops/Analyzers#535 (a "global" alcops.json for company-wide rules), which is already achievable with the two mechanisms this page now covers.

  • New "Where alcops.json is loaded from" section — documents the parent-directory traversal (search starts in the app folder and walks up to the filesystem root, nearest file wins, no merging), with a workspace-layout diagram and the boundary behavior. This was previously undocumented.
  • Comparison table contrasting traversal (single file, nearest wins, same repo/workspace) with Extends.Source (base + local merged, company-wide, recommended).
  • Reframed "Extending a central configuration" — leads with Extends as the recommended way to share one config across all company apps, and breaks the loading behavior / limits prose into scannable groups (fetching, all-or-nothing failure, caching and reloads). Every existing fact is preserved.

Docs-only; no analyzer changes.

Verification

  • hugo --gc --minify builds clean.
  • Both new intra-page anchor links resolve (#where-alcopsjson-is-loaded-from, #extending-a-central-configuration).

🤖 Generated with Claude Code

Document the parent-directory traversal used to locate alcops.json
(nearest file wins, no merging) with a workspace layout example, and add
a comparison table contrasting it with Extends. Reframe the central
configuration section around sharing one config company-wide and break
its loading behavior and limits into scannable groups.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Arthurvdv
Arthurvdv merged commit 3bbcc5a into main Sep 9, 2026
1 check passed
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