Conversation
This change was made using Codex with CPT-5.4 and the following prompt: "can you convert source/developers/coding-style.rst to md?" Overall, the conversion went very well. It did add ".md" to source_suffix but it's not clear from the following docs that it's necessary: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-source_suffix https://myst-parser.readthedocs.io/en/latest/ It doesn't seem to hurt, however, so we'll leave it in. The only other oddity is that is surrounded "Source -> Format", for example, with backticks.
pdurbin
added
Feature: Developer Guide
Size: 0.5
cmbz
added
FY26 Sprint 20
stevenwinship
moved this from Ready for Review ⏩
to In Review 🔎
in IQSS Dataverse Project
stevenwinship
approved these changes
Apr 9, 2026
github-project-automation
bot
moved this from In Review 🔎
to Ready for QA ⏩
in IQSS Dataverse Project
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
It converts an rst file to md. md is the preferred format these days.
This also an experiment to see if Codex can easily handle this task and it can. This is the prompt I used:
"can you convert source/developers/coding-style.rst to md?"
Which issue(s) this PR closes:
None
Special notes for your reviewer:
Overall, the conversion went very well. It did add ".md" to
source_suffix but it's not clear from the following docs that
it's necessary:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-source_suffix
https://myst-parser.readthedocs.io/en/latest/
It doesn't seem to hurt, however, so we'll leave it in.
I didn't like how it added some extra backticks so in a separate commit I removed them.
As for the actual changes, I'm pretty sure that these two pages are fairly indistinguishable (there's a bit more syntax highlighting in the new one):
Here's a screenshot of the Codex session: