Skip to content

fix: point Studio home "Getting started" link to working Open edX docs#16

Merged
choeying-10 merged 1 commit into
wbc-ulmo1-stagefrom
feature/fix-studio-help-links-footer
Jun 2, 2026
Merged

fix: point Studio home "Getting started" link to working Open edX docs#16
choeying-10 merged 1 commit into
wbc-ulmo1-stagefrom
feature/fix-studio-help-links-footer

Conversation

@choeying-10

Copy link
Copy Markdown

Summary

Fixes the broken "Getting started with Studio" link in the Studio home page sidebar. It was pointing at a retired edx.readthedocs.io page and now points at the current Open edX educators quickstart.

Problem

The sidebar link ("New to … Studio?" → "Getting started with … Studio") gets its URL from the home help token, which is served by the Studio backend (/api/contentstore/v1/help_urls, built from cms/envs/help_tokens.ini + HELP_TOKENS_BOOKS). On this deployment that token still resolves to a retired readthedocs URL, so the link 404s.

Change

Override the home token in the help-urls thunk after it's fetched, so the sidebar link resolves to the working docs page:
https://docs.openedx.org/en/latest/educators/quickstarts/build_a_course.html

  • File: src/help-urls/data/thunks.js
  • Scope: the home token is only consumed by the Studio home sidebar, so the override is fully contained.
  • This is intentionally a frontend stopgap (documented in a code comment). The "correct" long-term fix is migrating the backend help_tokens config to docs.openedx.org; that's a broader, backend-repo change and is noted in the comment.

The `home` help token returned by the Studio backend resolves to a retired
readthedocs page. Override it in the help-urls thunk with the current Open edX
educators quickstart URL until the backend help_tokens config is migrated.

Co-authored-by: Cursor <cursoragent@cursor.com>
@choeying-10 choeying-10 requested a review from 10kalden June 2, 2026 05:14
@choeying-10 choeying-10 self-assigned this Jun 2, 2026
@choeying-10 choeying-10 added the bug Something isn't working label Jun 2, 2026
@choeying-10 choeying-10 merged commit 42a41f2 into wbc-ulmo1-stage Jun 2, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants