docs: restore the pointer to the plug-in and frontend Quickstarts - #1520
Conversation
The paragraph directing plug-in and frontend developers elsewhere was live text when this page was added in 0a6371f. f2f264e then deleted the two empty "Coming Soon!" placeholders it linked to and commented the paragraph out, noting "We can add the files back when there is" content. That content exists now: tutor_quickstart_dev covers setting up a development environment and tutor_quickstart_mfe covers frontend work. The paragraph points at those two by their existing :ref: labels, so it renders again instead of sitting in a comment for four years. Co-authored-by: Claude <claude@anthropic.com>
|
Thanks for the pull request, @rawsun007! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
first_openedx_pr.rstcarries this paragraph as an RST comment, so it has never rendered:It was live text when the page was added in
0a6371f.f2f264e— "docs: Remove empty placeholder files" — deleted the twoComing Soon!placeholders it linked to and commented the paragraph out in the same commit, with the note:That content exists now.
tutor_quickstart_dev.rstis "Tutor Quickstart (Developer)" andtutor_quickstart_mfe.rstis "Tutor Quickstart (MFE Development)", which are the two audiences the paragraph was sending away. This points at them by the:ref:labels those pages already define, so the signpost renders again rather than sitting in a comment.Nothing else on the page changes, and no new label is introduced.
Because the targets were inside a comment, Sphinx never resolved them, so there was no build warning to catch this — it only shows up by reading.
The wording of the replacement is my reading of the original intent: "plug-in developer" became "setting up a development environment", since
tutor_quickstart_devis the general dev-environment guide rather than a plug-in-specific one. If you would rather it said something else, or would rather the paragraph stay commented, say so and I will adjust or close.Verification:
sphinx -b html sourcebuilds with zero warnings, and the rendered page contains both links:AI disclosure, per the Open edX AI Contribution Policy: written by Claude Opus 5 (Claude Code) running under my account, which is one of the permitted tools. It found the commented block, traced the two commits above, chose the replacement targets and ran the docs build. I have not read the diff line by line myself yet.