Skip to content

docs: Fix broken links and update outdated refresh references#42

Merged
robinebers merged 1 commit intomainfrom
docs/fix-links-and-api
Feb 2, 2026
Merged

docs: Fix broken links and update outdated refresh references#42
robinebers merged 1 commit intomainfrom
docs/fix-links-and-api

Conversation

@robinebers
Copy link
Owner

@robinebers robinebers commented Feb 2, 2026

Fix broken links in README and update all documentation to reflect current auto-update timer behavior (manual Refresh button was removed).

Changes

  • Fix 2 broken links in README (docs/openusage-api.mddocs/plugins/api.md)
  • Update all "Refresh" references to reflect auto-update timer behavior
  • Delete docs/choices.md and docs/breadcrumbs.md, add to .gitignore

Made 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 adds docs/choices.md / docs/breadcrumbs.md to .gitignore while 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.

…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.
@macroscopeapp
Copy link

macroscopeapp bot commented Feb 2, 2026

Update docs to reflect configurable auto-update interval (5/15/30/60 min) and fix Plugin API link path in README.md

Revise 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 Start

Start with the Execution Timing section in docs/plugins/api.md and the architecture notes in docs/plugins/schema.md.


Macroscope summarized 723ebb0.

@robinebers robinebers merged commit 6c5502c into main Feb 2, 2026
3 checks passed
@robinebers robinebers deleted the docs/fix-links-and-api branch February 2, 2026 15:09
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 with Cubic

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