Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Sep 17, 2025

About

Start converting documents from reStructuredText to Markdown actively.

Details

After our Sphinx setup learned to understand MyST Markdown the other day, we can gradually leave reStructuredText behind for those who can't write it, at least on the repositories where that is possible.

How this works

... without needing to type it all out.

rst2myst convert docs/admin/going-into-production.rst

Preview

References

Trivia

@coderabbitai ignore

@amotl amotl added the reorganize Moving content around, inside and between other systems. label Sep 17, 2025
@coderabbitai
Copy link

coderabbitai bot commented Sep 17, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch admin-myst

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 and usage tips.

@amotl amotl force-pushed the admin-myst branch 5 times, most recently from 441bbd5 to 6bf55e0 Compare September 17, 2025 22:21
@amotl amotl changed the title Chore: Convert documents in "admin" section into MyST format Chore: Convert admin/* into MyST format Sep 18, 2025
@amotl amotl requested review from bmunkholm and surister September 18, 2025 00:49
@amotl amotl marked this pull request as ready for review September 18, 2025 00:49
Copy link
Contributor

@bmunkholm bmunkholm left a comment

Choose a reason for hiding this comment

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

LGTM in principle.
I haven't checked each page, so if you have checked at least the references that was updated from http links to proper ref (thanks!) then I would assume all good.

@amotl amotl merged commit bb52482 into main Sep 18, 2025
3 checks passed
@amotl amotl deleted the admin-myst branch September 18, 2025 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

reorganize Moving content around, inside and between other systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants