Skip to content

docs: Convert documentation from reStructuredText to Markdown #1393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 12, 2025

Conversation

nakamura-to
Copy link
Member

Summary

  • Converted all documentation files from .rst to .md format
  • Updated Sphinx configuration to use MyST parser for Markdown support
  • Updated all translation files to reflect content changes

Test plan

  • Build documentation locally with sphinx-autobuild
  • Verify all internal links work correctly
  • Check that code blocks render properly
  • Confirm translation files are updated correctly
  • Test documentation deployment on ReadTheDocs

🤖 Generated with Claude Code

Migrate all documentation files from .rst to .md format for improved maintainability
and developer experience. Update Sphinx configuration to use MyST parser for Markdown
support. Update translation files to reflect content changes.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@github-actions github-actions bot added the docs label Jul 11, 2025
Copy link

read-the-docs-community bot commented Jul 11, 2025

Documentation build overview

📚 doma | 🛠️ build #28831382 (c5921d7) | 🔍 preview

Files changed

Comparing with latest (d65ad0a)

Show files (33) | 33 modified | 0 added | 0 deleted
File Status
index.html 📝 modified
aggregate-strategy/index.html 📝 modified
annotation-processing/index.html 📝 modified
basic/index.html 📝 modified
build/index.html 📝 modified
codegen/index.html 📝 modified
config/index.html 📝 modified
criteria-api/index.html 📝 modified
dao/index.html 📝 modified
domain/index.html 📝 modified
embeddable/index.html 📝 modified
entity/index.html 📝 modified
expression/index.html 📝 modified
faq/index.html 📝 modified
getting-started/index.html 📝 modified
kotlin-support/index.html 📝 modified
query/index.html 📝 modified
query-builder/index.html 📝 modified
query-dsl/index.html 📝 modified
slf4j-support/index.html 📝 modified
sql/index.html 📝 modified
transaction/index.html 📝 modified
query/batch-delete/index.html 📝 modified
query/batch-insert/index.html 📝 modified
query/batch-update/index.html 📝 modified
query/delete/index.html 📝 modified
query/function/index.html 📝 modified
query/insert/index.html 📝 modified
query/multi-row-insert/index.html 📝 modified
query/procedure/index.html 📝 modified
query/script/index.html 📝 modified
query/select/index.html 📝 modified
query/update/index.html 📝 modified

Copy link

read-the-docs-community bot commented Jul 11, 2025

Documentation build overview

📚 doma-japanese | 🛠️ build #28831383 (c5921d7) | 🔍 preview

Files changed

Comparing with latest (d65ad0a)

Show files (35) | 35 modified | 0 added | 0 deleted
File Status
index.html 📝 modified
aggregate-strategy/index.html 📝 modified
annotation-processing/index.html 📝 modified
basic/index.html 📝 modified
build/index.html 📝 modified
codegen/index.html 📝 modified
config/index.html 📝 modified
criteria-api/index.html 📝 modified
dao/index.html 📝 modified
domain/index.html 📝 modified
embeddable/index.html 📝 modified
entity/index.html 📝 modified
expression/index.html 📝 modified
faq/index.html 📝 modified
getting-started/index.html 📝 modified
kotlin-support/index.html 📝 modified
lombok-support/index.html 📝 modified
quarkus-support/index.html 📝 modified
query-builder/index.html 📝 modified
query-dsl/index.html 📝 modified
slf4j-support/index.html 📝 modified
spring-boot-support/index.html 📝 modified
sql/index.html 📝 modified
transaction/index.html 📝 modified
query/batch-delete/index.html 📝 modified
query/batch-insert/index.html 📝 modified
query/batch-update/index.html 📝 modified
query/delete/index.html 📝 modified
query/function/index.html 📝 modified
query/insert/index.html 📝 modified
query/multi-row-insert/index.html 📝 modified
query/procedure/index.html 📝 modified
query/script/index.html 📝 modified
query/select/index.html 📝 modified
query/update/index.html 📝 modified

nakamura-to and others added 7 commits July 12, 2025 01:58
Convert all Sphinx-style {doc}`path` references to standard Markdown
link syntax [](path.md) throughout the documentation. This change
affects 21 documentation files and ensures compatibility with standard
Markdown processors.

- Simple references: {doc}`basic` → [](basic.md)
- References with text: {doc}`SQL template <../sql>` → [SQL template](../sql.md)
- Relative paths: {doc}`../entity` → [](../entity.md)
- Nested paths: {doc}`query/select` → [](query/select.md)

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Convert all MyST-specific link syntax to standard Markdown link format
for better compatibility and consistency across the documentation.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Add commented Markdown links for better editor navigation
- Fix capitalization typo in faq.md

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Remove all fuzzy markers from 41 PO files (777 fuzzy messages total)
- Convert RST-style formatting to Markdown in Japanese translations
- Change double backticks to single backticks for code terms
- Update cross-references from :doc:/:ref: to Markdown link format
- Preserve translation meaning while updating formatting conventions

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Remove excessive indentation in the Kotlin build.gradle.kts code block
to improve readability and consistency with standard formatting.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@nakamura-to nakamura-to merged commit 22d1c9c into master Jul 12, 2025
15 checks passed
@nakamura-to nakamura-to deleted the docs/rst-to-md branch July 12, 2025 03:37
@nakamura-to nakamura-to changed the title Convert documentation from reStructuredText to Markdown docs: Convert documentation from reStructuredText to Markdown Jul 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant