Skip to content

improvement(pi): minor improvements to docs#5192

Merged
icecrasher321 merged 1 commit into
stagingfrom
improvement/pi-agent-dcs
Jun 24, 2026
Merged

improvement(pi): minor improvements to docs#5192
icecrasher321 merged 1 commit into
stagingfrom
improvement/pi-agent-dcs

Conversation

@icecrasher321

@icecrasher321 icecrasher321 commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

Reorder things a bit for Pi coding agent docs and make link refs work.

Type of Change

  • Documentation

Testing

Tested manually

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 24, 2026 7:02am

Request Review

@cursor

cursor Bot commented Jun 24, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only edits (nav order, copy, heading anchors) with no runtime or security behavior changes.

Overview
Pi block docs are tweaked for navigation and linking, with a small wording change.

The Core Blocks sidebar order moves Pi from near the top (after Agent) to the end of the list (after Credential).

In pi.mdx, the Cloud BYOK bullet is shortened (drops the extra line about Sim not injecting a hosted key). Setup subsections gain explicit heading anchors [#setup-cloud] and [#setup-local] so in-doc links like "see Setup" resolve correctly.

Reviewed by Cursor Bugbot for commit a3eb6bc. Configure here.

@greptile-apps

greptile-apps Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR makes minor documentation improvements to the Pi Coding Agent block, reordering it in the navigation and fixing two issues in the MDX content.

  • meta.json: Moves the pi entry from near the top of the nav list (position 2) to the end, after credential.
  • pi.mdx: Simplifies a BYOK bullet by dropping the explanatory clause "so Sim never injects a hosted key there", and adds explicit heading anchors ([#setup-cloud], [#setup-local]) to the Cloud and Local setup sections — which fixes an already-present internal link (see [Setup](#setup-cloud)) that previously resolved to nothing.

Confidence Score: 5/5

Safe to merge — purely documentation changes with no runtime code affected.

Both files are docs-only. The navigation reordering is intentional, the anchor additions fix a previously broken internal link, and the BYOK bullet simplification removes a redundant clause without losing accuracy.

No files require special attention.

Important Files Changed

Filename Overview
apps/docs/content/docs/en/workflows/blocks/meta.json Moves the pi page entry from position 2 to the last position in the sidebar navigation list.
apps/docs/content/docs/en/workflows/blocks/pi.mdx Adds [#setup-cloud] and [#setup-local] anchors to fix a previously broken internal link, and trims a redundant explanatory clause from the BYOK bullet.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Sidebar Nav meta.json] --> B[pi moved to last position]
    C[pi.mdx content] --> D[BYOK bullet simplified]
    C --> E["### Cloud [#setup-cloud] anchor added"]
    C --> F["### Local [#setup-local] anchor added"]
    E --> G["Internal link #setup-cloud now resolves correctly"]
    F --> H["Internal link #setup-local now resolves correctly"]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[Sidebar Nav meta.json] --> B[pi moved to last position]
    C[pi.mdx content] --> D[BYOK bullet simplified]
    C --> E["### Cloud [#setup-cloud] anchor added"]
    C --> F["### Local [#setup-local] anchor added"]
    E --> G["Internal link #setup-cloud now resolves correctly"]
    F --> H["Internal link #setup-local now resolves correctly"]
Loading

Reviews (1): Last reviewed commit: "improvement(pi): minor improvements to d..." | Re-trigger Greptile

@icecrasher321 icecrasher321 merged commit 5d7f7e9 into staging Jun 24, 2026
17 checks passed
@waleedlatif1 waleedlatif1 deleted the improvement/pi-agent-dcs branch June 24, 2026 07:12
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