Repository navigation
[Docs] Describe the current behavior by area - #263
Merged
Merged
Conversation
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
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
Closed
Open
Open
Closed
Open
Closed
Open
[BUG] Scan History and Dashboard texts claim discovery and cleanup runs that are never recorded
#278
Open
[Feature] Optional forwarded-headers support for running behind a TLS-terminating reverse proxy
#283
Open
Open
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
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 file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



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.mdindexes the areas, and the existing decision records get theirArea:field (—, since all three are about the process).ARCHITECTURE.mdnow 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,BuildStageedges, 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.mdconfiguration reference is aligned with the current behavior where no issue changes it (Scanning:RetryCount,DockerHub:RequestTimeoutSeconds, theDatabasekeys, environment variables as a configuration source, the telemetry switches, where the version is shown). Statements inREADME.mdand.squad/project.mdthat describe a planned fix (for exampleMaxParallelRequests,DockerHub:Registry, theAllowInsecureHttpruntime 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
.squad/stack.md, and the Analyzer gate reports no diagnostic in a changed file. (n/a, no code).squad/stack.mdpasses (line coverage on new or changed production code and overall). (n/a, no code)README.md,ARCHITECTURE.md) to reflect my changes..squad/stack.mdprescribes. (n/a)⏭ Next Steps
Work the linked issues with the squad (
squad-issuefor bugs,squad-specfor #280, #283 and #291); each fix removes its Known gaps entry.