Skip to content

Differentiate Quickstart entries and apply style audit fixes#36

Closed
micheleRP wants to merge 1 commit into
mainfrom
docs/quickstart-rename-and-audit
Closed

Differentiate Quickstart entries and apply style audit fixes#36
micheleRP wants to merge 1 commit into
mainfrom
docs/quickstart-rename-and-audit

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 27, 2026

Summary

  • Relabel the three identically-named "Quickstart" entries in modules/ROOT/nav.adoc as ADP Quickstart, AI Agent Quickstart, and AI Gateway Quickstart so the sidenav distinguishes them.
  • Fix modules/agents/pages/quickstart.adoc: change :page-topic-type: tutorial to quickstart, and replace three references to the nonexistent "Remote MCP Quickstart" page with proper xrefs to mcp:create-server.adoc.
  • Apply docs-team-standards:audit findings across the repo: no future tense ("will use" → "uses"; "will be accessible" → "are accessible"), no quotation-mark emphasis ("Active"/"Enabled"), no bold column headers (gateway overview metrics), no directional refs ("see... below" → proper xref), SSL → TLS in the GitHub Copilot admin partial, and rephrase a "There is no..." sentence in mcp/managed/metabase.adoc.
  • Repair two broken scripts in package.json: repoint test-quickstart to the actual byoc-quickstart.adoc path, and remove test-console-auth (no console module exists in this repo).

Preview pages

Test plan

  • npm run build completes with no new errors or warnings beyond the pre-existing ones in auto-generated rpk files
  • Sidenav shows ADP Quickstart at top level, AI Agent Quickstart under Agents, and AI Gateway Quickstart under AI Gateway
  • Each renamed quickstart link in the nav loads its page
  • The Prerequisites bullet on agents/quickstart.adoc now links to "Create an MCP Server" instead of the nonexistent Remote MCP Quickstart
  • Dashboard metric labels on the AI Gateway Quickstart render as plain text (not bold)

🤖 Generated with Claude Code

Rename the three identically-labeled "Quickstart" nav entries to ADP
Quickstart, AI Agent Quickstart, and AI Gateway Quickstart so the TOC
distinguishes them. Fix accuracy issues uncovered while reviewing:
agents/quickstart.adoc had page-topic-type: tutorial and linked to a
nonexistent "Remote MCP Quickstart" page; both corrected. Apply
docs-team-standards audit findings (no future tense, no quotation-mark
emphasis, no bold column headers, no directional refs, SSL → TLS).
Repair broken test-quickstart and test-console-auth scripts in
package.json.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner May 27, 2026 23:16
@netlify
Copy link
Copy Markdown

netlify Bot commented May 27, 2026

Deploy Preview for redpanda-agentic-data-plane ready!

Name Link
🔨 Latest commit fb756f3
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/6a177b37a8d3ca00084faedf
😎 Deploy Preview https://deploy-preview-36--redpanda-agentic-data-plane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@micheleRP micheleRP enabled auto-merge May 28, 2026 00:00
@micheleRP
Copy link
Copy Markdown
Contributor Author

Superseded by #37 — the commit was cherry-picked onto the overview-reorder branch so the two changes ship as one PR. Closing here to avoid two parallel merges.

@micheleRP micheleRP closed this May 28, 2026
auto-merge was automatically disabled May 28, 2026 00:20

Pull request was closed

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