Skip to content

fix(vscode): repoint example links to repo pipelines (#1422)#1435

Closed
kairavb wants to merge 2 commits into
rocketride-org:developfrom
kairavb:fix/RR-1422-broken-example-links
Closed

fix(vscode): repoint example links to repo pipelines (#1422)#1435
kairavb wants to merge 2 commits into
rocketride-org:developfrom
kairavb:fix/RR-1422-broken-example-links

Conversation

@kairavb

@kairavb kairavb commented Jul 2, 2026

Copy link
Copy Markdown

Replace broken docs.rocketride.org example URLs with working GitHub links to examples/*.pipe. Align issue template docs URL to .org domain.

Summary

  • Repoint VS Code extension example links from dead docs.rocketride.org/examples/* URLs to working GitHub links for real examples/*.pipe templates (rag-pipeline, document-processor, agent-llamaindex)
  • Update both the marketplace README source (docs/README-vscode.md) and co-located extension docs (apps/vscode/docs/index.md)
  • Align the GitHub issue template documentation contact link from docs.rocketride.ai to docs.rocketride.org

Type

  • Bug fix (non-breaking change which fixes an issue)

Testing

  • Tests added or updated (not needed for docs-only change)
  • Tested locally
  • ./builder test passes (not required for markdown/config-only change)

Checklist

  • Commit messages follow conventional commits
  • No secrets or credentials included
  • Wiki updated (if applicable)
  • Breaking changes documented (if applicable)

Linked Issue

Fixes #1422

Summary by CodeRabbit

  • Documentation
    • Updated the documentation support contact link to the new docs domain.
    • Refreshed “Need inspiration?” example pipeline links in the VS Code docs to point to three GitHub-hosted .pipe files on the develop branch: RAG Pipeline, Document Processor, and LlamaIndex Agent.
    • Replaced the previous external example pipeline links with the repository-based equivalents.

Replace broken docs.rocketride.org example URLs with working GitHub
links to examples/*.pipe. Align issue template docs URL to .org domain.

Fixes rocketride-org#1422

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions github-actions Bot added docs Documentation module:vscode VS Code extension ci/cd CI/CD and build system labels Jul 2, 2026
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor
🤖 Internal: Discord sync marker

Auto-managed by the Discord notification workflow. Stores the linked Discord message ID. Do not edit or delete.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0096bdec-26ff-4abc-84d7-e49250dc8e60

📥 Commits

Reviewing files that changed from the base of the PR and between 037345b and 2382ebb.

📒 Files selected for processing (2)
  • apps/vscode/docs/index.md
  • docs/README-vscode.md

📝 Walkthrough

Walkthrough

This PR updates documentation links in the VS Code docs and issue template, repointing example pipeline links to GitHub-hosted .pipe files and changing the contact URL to the .org domain.

Changes

Documentation link fixes

Layer / File(s) Summary
Repoint VS Code example pipeline links
apps/vscode/docs/index.md, docs/README-vscode.md
Replaces docs.rocketride.org example pipeline links with GitHub links to develop/examples .pipe files: RAG Pipeline, Document Processor, LlamaIndex Agent.
Fix issue template domain
.github/ISSUE_TEMPLATE/config.yml
Updates the documentation contact link URL from docs.rocketride.ai to docs.rocketride.org.

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

Suggested reviewers: jmaionchi, stepmikhaylov, Rod-Christensen

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning [#1422] The example links were repointed, but the requested .org/.ai domain reconciliation appears incomplete because apps/vscode/src/config.ts is unchanged. Update the remaining VS Code config to use the chosen domain consistently across docs, support links, and config files.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: repointing VS Code example links to repository pipelines.
Out of Scope Changes check ✅ Passed The changed files stay within the docs link fix and related domain cleanup; no unrelated feature or code changes are evident.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@kairavb kairavb changed the title fix(vscode): repoint example links to repo pipelines fix(vscode): repoint example links to repo pipelines (#1422) Jul 2, 2026
dsapandora
dsapandora previously approved these changes Jul 2, 2026

@dsapandora dsapandora left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nice, this is a satisfying little fix — dead links replaced with links to the actual .pipe files people can read right away instead of a 404'd docs page. Good call pointing at real examples (rag-pipeline, document-processor, agent-llamaindex) instead of the vague ones that used to be referenced.

One thing worth a quick gut-check before merging: all six new example links are hardcoded to blob/develop/.... That's fine today, but if develop ever gets rebased/renamed or those files move, the links go stale again — which is exactly the problem this PR is fixing. Not a blocker, just something to keep in mind (a raw.githubusercontent link or tagging the URL to a stable release branch would age better, but browsable blob links are more useful for someone clicking through in the marketplace README, so I get the tradeoff).

Also double check that examples/rag-pipeline.pipe, examples/document-processor.pipe, and examples/agent-llamaindex.pipe actually exist at those exact paths on develop — a typo here would be an easy miss since it's just three markdown files and nothing will fail CI on a bad link.

The docs.rocketride.ai.org swap in the issue template looks like a straightforward alignment fix, no concerns there. Overall this is a clean, well-scoped docs patch — good to go once the links are confirmed live.

Comment thread apps/vscode/docs/index.md Outdated
- **SDKs for TypeScript, Python & MCP** - Embed pipelines in your apps or expose them as tools for AI assistants.

Need inspiration? Check out our [example pipelines](https://docs.rocketride.org/):
Need inspiration? Check out our [example pipelines](https://github.com/rocketride-org/rocketride-server/tree/develop/examples):

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This needs to point to the awesome-rocketride repository

@kairavb

kairavb commented Jul 2, 2026

Copy link
Copy Markdown
Author

Confirmed all three .pipe files exist at those paths on develop and the links resolve (200). Kept blob/develop links for the individual templates since they’re directly browsable from the marketplace README

Updated to point at awesome-rocketride as requested. Thanks!

@charliegillet

Copy link
Copy Markdown
Collaborator

Hey @kairavb, sorry, this one's on us and not on you.

You read the issue right, you got here first, and when Josh asked you to repoint at awesome-rocketride you turned it around the same day. Meanwhile we settled internally on a slightly different shape for that section: drop the bullet list entirely and just link awesome-rocketride, so the catalog lives in one place and the extension README stops going stale every time an example moves. That's a call we made after you'd already done the work. It went in as #1448 and is on develop now, which is why this shows as conflicting.

Different from what #1422 proposed, and different from this PR, but not because anything here was wrong.

One hunk of yours we didn't take: the .github/ISSUE_TEMPLATE/config.yml switch from docs.rocketride.ai to docs.rocketride.org. .ai redirects to .org so nothing is actually broken, but #1422 asks for it and I'd rather the repo be consistent. It's still unfixed on develop. If you want to open that as a one-liner against develop I'll review it.

Closing this one. There's a lot left unclaimed in the #1402 to #1432 batch if you're up for another.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/cd CI/CD and build system docs Documentation module:vscode VS Code extension

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken VS Code example links → repoint to real repo examples/; fix .org/.ai domain drift

4 participants