Skip to content

[Docs] Describe the current behavior by area - #263

Merged
LarsLaskowski merged 12 commits into
mainfrom
docs/areas-current-behavior
Oct 18, 2026
Merged

LarsLaskowski merged 12 commits into
mainfrom
docs/areas-current-behavior

Conversation

@LarsLaskowski

@LarsLaskowski LarsLaskowski commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

Pull Request

📖 Description

This adds one normative area document per area under docs/areas/: hosting, Docker instances, registries, image catalog, base images, update detection, vulnerabilities, container actions, scan engine, web UI and telemetry. Each one states the formats, defaults, limits, error behavior and guarantees the code shows today; where the current behavior falls short of the intended one, a Known gaps entry describes it and links the issue that tracks the fix. docs/areas/README.md indexes the areas, and the existing decision records get their Area: field (—, since all three are about the process). ARCHITECTURE.md now links the areas instead of repeating behavioral detail, and its claims the code contradicts are corrected: retry scope, configuration reload, emitted span names, Portainer actions, BuildStage edges, the Dashboard refresh signal and the release base-digest label. This is a documentation-only change; no code is touched.

🎫 Issues

Known gaps link these issues: #264, #265, #266, #267, #268, #269, #270, #271, #272, #273, #274, #275, #276, #277, #278, #279, #280, #281, #282, #283, #284, #285, #286, #287, #288, #289, #290, #291, #292, #293, #294, #295, and the existing #37, #40, #83.

💬 Reviewer Notes

Behavior confirmed as intended is stated as a plain rule (for example: removing a Docker instance deletes its history, the Docker Hub request budget is a scheduling hint, partial scan runs are not counted as failed). Everything else that differs from the intended behavior is a Known gaps entry, so no document carries open questions. The README.md configuration reference is aligned with the current behavior where no issue changes it (Scanning:RetryCount, DockerHub:RequestTimeoutSeconds, the Database keys, environment variables as a configuration source, the telemetry switches, where the version is shown). Statements in README.md and .squad/project.md that describe a planned fix (for example MaxParallelRequests, DockerHub:Registry, the AllowInsecureHttp runtime warning, the UI that triggers container actions) are updated by the linked issues together with that fix.

📑 Test Plan

Documentation only. .squad/tools/config-check.py (including the decision and area index checks) passes.

✅ Checklist

  • I have added or updated Unit Tests for the change. (n/a, docs only)
  • I have tested my changes.
  • I have run Format and Build from .squad/stack.md, and the Analyzer gate reports no diagnostic in a changed file. (n/a, no code)
  • The Coverage gate in .squad/stack.md passes (line coverage on new or changed production code and overall). (n/a, no code)
  • I have updated the project documentation (README.md, ARCHITECTURE.md) to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the project's code style guidelines.
  • New dependencies, if any, were added the way Dependencies in .squad/stack.md prescribes. (n/a)

⏭ Next Steps

Work the linked issues with the squad (squad-issue for bugs, squad-spec for #280, #283 and #291); each fix removes its Known gaps entry.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A3Rn7L5t5JApSC3JeXZbNd
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A3Rn7L5t5JApSC3JeXZbNd
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A3Rn7L5t5JApSC3JeXZbNd
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A3Rn7L5t5JApSC3JeXZbNd
This was referenced Oct 18, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A3Rn7L5t5JApSC3JeXZbNd
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A3Rn7L5t5JApSC3JeXZbNd
@sonarqubecloud

Copy link
Copy Markdown

@LarsLaskowski
LarsLaskowski marked this pull request as ready for review October 18, 2026 20:41
@LarsLaskowski
LarsLaskowski merged commit 1b542e6 into main Oct 18, 2026
4 checks passed
@LarsLaskowski
LarsLaskowski deleted the docs/areas-current-behavior branch October 18, 2026 20:43
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.

2 participants