Skip to content

docs: restore OpenShell integration links - #4098

Open
Ricky Gummadi (Ricky-G) wants to merge 4 commits into
mainfrom
ricky-g-fix-openshell-skill-link
Open

Ricky Gummadi (Ricky-G) wants to merge 4 commits into
mainfrom
ricky-g-fix-openshell-skill-link

Conversation

@Ricky-G

@Ricky-G Ricky Gummadi (Ricky-G) commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Restores the retired OpenShell integration guide as v5 migration guidance and preserves the long-broken package documentation URL for existing inbound links.

Problem

The OpenShell integration guide was retired in #3451, leaving its published URL as a 404. The guide also linked to the openshell-skill package path, which was never served as a documentation page and has always returned 404. Both routes were reported in #3348.

Changes

File What changed
docs/integrations/openshell.md Adds the canonical v5 migration guide and preserves the legacy section anchor.
docs/agent-governance-python/agentmesh-integrations/openshell-skill/index.md Adds a legacy-route page that redirects callers to the canonical migration guidance.
mkdocs.yml Adds the canonical OpenShell guide to the Integration Guides navigation.

Testing

  • python scripts/docs/check_links.py
  • python scripts/docs/check_frontmatter.py --strict
  • Rendered the documentation site in an isolated environment and verified the canonical page, legacy route, redirect target, and preserved anchor. The full strict MkDocs build remains blocked by 33 unrelated existing link warnings and the configured package feed's missing jsmin dependency for the minifier.

Closes #3348

Closes #3348

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Ricky Gummadi <ricky.gummadi@outlook.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 23, 2026
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@github-actions github-actions Bot added the size/M Medium PR (< 200 lines) label Sep 23, 2026
@github-actions

Copy link
Copy Markdown

PR Review Summary

Check Status Details
🔍 Code Review ⚠️ Missing No current-run comment
🛡️ Security Scan ⚠️ Missing No current-run comment
🔄 Breaking Changes ⚠️ Missing No current-run comment
📝 Docs Sync ⚠️ Missing No current-run comment
🧪 Test Coverage ⚠️ Missing No current-run comment

Verdict: ⚠️ AI review incomplete; ready for human review

AI review comments are untrusted advisory output. The summary reports workflow-generated completion status only, not model-authored pass/fail claims.

@MohammadHaroonAbuomar MohammadHaroonAbuomar 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.

  • Before the small items: this guide was retired on purpose in #3451 ("docs: retire the openshell integration page"), and open #3728 (imran-siddique) restores the GovernanceSkill / governed_shell adapter in code, which would make this page's central claim ("APIs are no longer available") false the day it merges. Whether the site wants a tombstone guide for a removed integration is a maintainer call, so I am holding the merge on that. The pages themselves build cleanly (33 warnings on both main and PR, identical set) and restore both #3348 URLs at the exact paths.
  • PR body, Problem paragraph: the openshell-skill URL never existed as a docs page. The retired guide linked a repo-relative path the site could not serve, so that link was broken before the v5 migration. Say that this adds a redirect stub for a long-broken link, and that the guide was retired in #3451.

Comment thread docs/integrations/openshell.md
Comment thread docs/agent-governance-python/agentmesh-integrations/openshell-skill/index.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Ricky Gummadi <ricky.gummadi@outlook.com>
@MohammadHaroonAbuomar

Copy link
Copy Markdown
Collaborator

Round two at ad2c72c: all three items are fixed with the exact wording, the site builds with the same 33 warnings as main, and both #3348 URLs render at their exact paths. Nothing is left on my side.

The hold is unchanged and is not yours to fix: the guide was retired on purpose in #3451, and #3728 (open, green) restores GovernanceSkill, ShellPolicyViolation and governed_shell at the same package path, which would make this page's "does not provide" sentence false on the day it merges. A maintainer needs to decide whether the site wants a retired-integration guide, and if so, whether this page or #3728 goes first. I will approve once that is settled.

@Ricky-G

Ricky Gummadi (Ricky-G) commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor Author

The requested fixes are complete and the checks pass. Since the remaining question is the intended sequencing with #3728, could you please make the call as the maintainer and codeowner for this repo. Please decide and approve.

@imran-siddique

Copy link
Copy Markdown
Collaborator

Restore the documentation routes without waiting for #3728. Describe the adapter’s absence as the current state following the v5 migration, and identify #3728 as a proposed restoration still under review. When that restoration lands, update this guide in the same change. This lets the link repair proceed without deciding the adapter review.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Ricky Gummadi <ricky.gummadi@outlook.com>
@Ricky-G

Copy link
Copy Markdown
Contributor Author

Implemented the sequencing decision in the latest commit: the guide now states that the adapter is currently absent after the v5 migration, identifies #3728 as a proposed restoration under review, and retains ACS guidance until that change merges. Documentation link and frontmatter validation pass.

@Ricky-G

Copy link
Copy Markdown
Contributor Author

MohammadHaroonAbuomar All done — could you please review again?

@MohammadHaroonAbuomar
MohammadHaroonAbuomar dismissed their stale review September 28, 2026 03:29

All three items from this review are met and verified at fef4065: the page is in the mkdocs nav, both redirect targets resolve, and the status text now describes the adapter as currently absent with the restore under review. Dismissing so the review no longer reads as a code block; the remaining question is the maintainer decision noted below.

@MohammadHaroonAbuomar

Copy link
Copy Markdown
Collaborator

Re-checked at fef4065: nav entry, both links and the reworded status all verified, and I have dismissed my earlier request so it no longer shows as a code block. One small update: docs/integrations/openshell.md:40 points at #3728, which was closed on 09-27 in favour of #4166 (same branch, same author); please repoint the link and the sentence to #4166.

What still holds this PR is not code. The page documents an integration that #3451 retired on purpose, and #4166 would restore it. Whether the site should carry an OpenShell page again is the maintainer decision that also gates #4166, and it is not mine to make. I will approve as soon as that lands one way or the other; if the answer is restore, this page and #4166 should merge together.

Signed-off-by: Ricky Gummadi <ricky.gummadi@outlook.com>
@Ricky-G

Copy link
Copy Markdown
Contributor Author

Updated the guide to reference #4166 in 317635d. The strict documentation link and frontmatter checks pass. MohammadHaroonAbuomar, could you please review again?

@MohammadHaroonAbuomar

Copy link
Copy Markdown
Collaborator

Verified at 317635d: the page now points at #4166, the strict link and frontmatter checks pass, and all ten checks are green. Nothing is open on this PR. It waits on the same maintainer decision as #4166, restore or retire the OpenShell integration; #4166 itself is now clear of every review item, so the two can merge together as soon as that decision lands.

@imran-siddique

Copy link
Copy Markdown
Collaborator

Let me start a thread with Ali and team from OpenShell

This branch has not been deployed

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

Labels

documentation Improvements or additions to documentation size/M Medium PR (< 200 lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: 404 Notfound - Install the OpenShell governance skill and use it from your agent's code

3 participants