docs: Fix broken links and update outdated refresh references#42
docs: Fix broken links and update outdated refresh references#42robinebers merged 1 commit intomainfrom
Conversation
…eature - Added new entries to .gitignore for agent working files: choices.md and breadcrumbs.md. - Updated README and plugin API documentation to reflect changes in the auto-update interval functionality. - Removed outdated breadcrumbs and choices documentation files. - Enhanced specs for the auto-update interval feature, clarifying UI elements and behavior.
Update docs to reflect configurable auto-update interval (5/15/30/60 min) and fix Plugin API link path in README.mdRevise plugin execution timing to use an auto-update timer and correct Plugin API links, remove deprecated docs, and ignore agent-generated doc files. 📍Where to StartStart with the Macroscope summarized 723ebb0. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 723ebb0267
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
1 issue found across 7 files
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name=".gitignore">
<violation number="1" location=".gitignore:31">
P2: Ignoring `/docs/choices.md` and `/docs/breadcrumbs.md` contradicts the documented workflow that requires updates to these files. Keeping them in `.gitignore` will prevent required decision/breadcrumb logs from being committed.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| !.env.example | ||
|
|
||
| # Agent working files | ||
| docs/choices.md |
There was a problem hiding this comment.
P2: Ignoring /docs/choices.md and /docs/breadcrumbs.md contradicts the documented workflow that requires updates to these files. Keeping them in .gitignore will prevent required decision/breadcrumb logs from being committed.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At .gitignore, line 31:
<comment>Ignoring `/docs/choices.md` and `/docs/breadcrumbs.md` contradicts the documented workflow that requires updates to these files. Keeping them in `.gitignore` will prevent required decision/breadcrumb logs from being committed.</comment>
<file context>
@@ -26,3 +26,7 @@ coverage
!.env.example
+
+# Agent working files
+docs/choices.md
+docs/breadcrumbs.md
</file context>
Fix broken links in README and update all documentation to reflect current auto-update timer behavior (manual Refresh button was removed).
Changes
docs/openusage-api.md→docs/plugins/api.md)docs/choices.mdanddocs/breadcrumbs.md, add to.gitignoreMade with Cursor
Note
Low Risk
Low risk: documentation-only updates plus ignoring agent-generated docs files; no runtime or build behavior changes.
Overview
Updates docs to reflect the current auto-update timer behavior (probes run on app load and on a configurable 5/15/30/60-minute interval) and removes outdated mentions of manual Refresh-driven probing.
Fixes broken README references by pointing the Plugin API link to
docs/plugins/api.md, and addsdocs/choices.md/docs/breadcrumbs.mdto.gitignorewhile deleting those agent working files from the repo.Written by Cursor Bugbot for commit 723ebb0. This will update automatically on new commits. Configure here.
Summary by cubic
Fix broken README links and update all docs to reflect the auto-update timer (5/15/30/60 min) replacing the manual Refresh button. Remove outdated breadcrumbs/choices docs and add them to .gitignore.
Written for commit 723ebb0. Summary will update on new commits.