Skip to content

docs(docs): point the roadmap at the follow-up issues and add it to the header - #374

Merged
erkamyaman merged 2 commits into
mainfrom
docs/roadmap-follow-ups
Oct 12, 2026
Merged

erkamyaman merged 2 commits into
mainfrom
docs/roadmap-follow-ups

Conversation

@erkamyaman

@erkamyaman erkamyaman commented Oct 12, 2026 •

Copy link
Copy Markdown
Member

What and why

How it was verified

  • pnpm commit:check
  • pnpm format:check
  • Docs in apps/docs updated, pnpm docs:build and the docs project tests pass

Summary by CodeRabbit

  • Documentation
    • Clarified that a page without router data receives a list of pages that have it, and no recordings are cleared. Each target must have the required settings enabled; requests for a single ineligible target are refused, while requests for all targets clear eligible ones and report skipped targets. The tool is not listed when no targets are eligible.
    • Updated the roadmap’s audit findings links and descriptions, and added a Roadmap link to the header navigation.

…ear-recordings gating

The audit issues #344 to #359 are closed. The items still open moved to #366
to #373, so the roadmap links there now. The clear-recordings section now
says that each target needs its action, agent tools and inspector, and what
an unknown page returns.
@github-actions github-actions Bot added the area: docs The documentation site label Oct 12, 2026
@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 793f9370-a41c-460e-98cf-91a9019f68b0

📥 Commits

Reviewing files that changed from the base of the PR and between 690fba9 and e9922ac.


📒 Files selected for processing (2)
  • apps/docs/src/content/agents/tools.md
  • apps/docs/src/content/roadmap.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.



📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The clear-recordings documentation now describes router-data responses and target eligibility. The roadmap now links issues 366–373 as open audit findings and proposed improvements.

Changes

clear-recordings documentation

Layer / File(s) Summary
Document responses and target eligibility
apps/docs/src/content/agents/tools.md
The documentation describes the response when a page has no router data. It also describes the settings required for a target to be eligible and the outcomes for single-target, all, and no-eligible-target cases.

Roadmap audit findings

Layer / File(s) Summary
Update audit-finding references
apps/docs/src/content/roadmap.md
The roadmap now links issues 366–373 and describes them as open findings and proposed improvements for each inspector and the package.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other


Merge Risk: ⚪ Minimal · up to e9922

The documentation clarifies existing clear-recordings behavior and refreshes the roadmap references; the supplied evidence supports the described behavior, with no material merge risk identified.

Architecture Summary

Architecture risk: 🔵 Low · up to e9922

The change affects 1 system.

Changed systems: apps/docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — apps/docs (service) was modified; 2 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in apps/docs/src/content/agents/tools.md: The clear-recordings documentation adds the no-router-data response, specifying that it lists reporting pages and clears nothing. It replaces the write-action-only availability rule with a requirement that the target’s write action, agent tool, and inspector are all enabled: a disabled setting refuses a single target, all skips ineligible targets while clearing eligible ones, and the tool is absent when none are eligible.
  • observed — Modified behavior in apps/docs/src/content/roadmap.md: The audit-findings text now points to issues #366–release: follow-ups for code health, CI, setup and the docs site #373 and specifies that they track open findings and proposed improvements for each inspector and the package; previously it linked #344–release: fixes and improvements for code health and CI #359 and described the findings more generally.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title accurately describes the roadmap update to reference follow-up issues. It does not mention the separate clear-recordings documentation update, but the title does not need to cover every chan…

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR

🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Failed ❌

View logs ↗
c49c685 2026-10-12T08:46:35.234Z View logs ↗
  • Build: Failed ❌

View logs ↗
e9922ac 2026-10-12T08:15:42.520Z View logs ↗

@nx-cloud

nx-cloud Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit c49c685

Command Status Duration Result
nx affected -t test build ✅ Succeeded 1m 7s View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-10-12 08:46:30 UTC

The roadmap was only reachable from the Community section of the sidebar.
A header link next to Docs, Inspectors and Agents makes it one click away.
@erkamyaman erkamyaman changed the title docs(docs): point the roadmap at the follow-up issues docs(docs): point the roadmap at the follow-up issues and add it to the header Oct 12, 2026
@erkamyaman
erkamyaman merged commit 8c1d5d9 into main Oct 12, 2026
7 of 10 checks passed
@erkamyaman
erkamyaman deleted the docs/roadmap-follow-ups branch October 12, 2026 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs The documentation site

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant