Document reusable maintenance lessons - #731
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Address the two documentation accuracy and duplication findings in dev/README.md.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds reusable maintenance guidance for documenting lessons, preserving review instances, and validating documentation screenshots.
Changes:
- Requires documenting verified reusable findings with
unslop. - Adds shared and app-specific lesson guidance.
- Documents Dozzle review preservation and screenshot-gallery checks.
File summaries
| File | Summary |
|---|---|
dev/README.md |
Adds maintenance and screenshot guidance. Two nit findings note duplicated Dozzle-specific guidance (1 vote) and inaccurate missing-image wording (3 votes). |
AGENTS.md |
Requires documenting reusable maintenance discoveries. |
Review details
Suppressed comments (1)
dev/README.md:235
- This shared section says app-specific setup and exceptions belong in
dev/<app>/README.md, but these lines add Dozzle-only, version-sensitive behavior that is already documented indev/dozzle/README.md:89-92. Keeping both copies can leave the workflow guidance stale; keep this section generic and retain the concrete Dozzle details in the app README.
by the app on its server. Dozzle shares its profile between the native and proxy
URLs, so automated appearance changes can affect the maintainer's tabs.
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+249
to
+252
| gallery loops over `config.extra.themes` and expects | ||
| `docs/site_assets/dozzle/<theme>.png`. Existing files can be missing options | ||
| that the gallery already references. Compare the configured list with the | ||
| captures instead of replacing only the images already present. |
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.
Require reusable findings to be documented with the unslop skill. Add lessons on preserving review instances and checking documentation screenshot galleries.
Validation: reviewed the Markdown and ran
git diff --check.