Skip to content
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

Fix Markdown links in reStructured Text #380

Closed
wants to merge 1 commit into from
Closed

Fix Markdown links in reStructured Text #380

wants to merge 1 commit into from

Conversation

@szepeviktor
Copy link
Contributor Author

szepeviktor commented Jun 26, 2023

@mvorisek Oh nooo!! There are a lot more Markdown links in .rst file.

@mvorisek
Copy link
Member

I personally prefer inlined links as there are easier to maintain.

ref: https://www.odoo.com/documentation/16.0/contributing/documentation/rst_cheat_sheet.html#external-hyperlinks
tested in https://www.tutorialspoint.com/online_restructure_editor.php

Also what is your opinion or rst vs. MD, what about converting everything from rst to MD?

@szepeviktor
Copy link
Contributor Author

This is the first rst file I send a PR to :)

@szepeviktor
Copy link
Contributor Author

Would you like me to convert all .rst files to .md?

@mvorisek
Copy link
Member

mvorisek commented Jun 27, 2023

Yes, PR is welcomed.

I did some research:

and the conversion from rst to md can be non-lossless, so I would like to see some discussion about different options considered.

I tried rst-to-myst and pandoc convertors. rst-to-myst is by order of magnitude better, but still a lot of manual changes are needed...

lint: https://github.com/DavidAnson/markdownlint

@mvorisek
Copy link
Member

mvorisek commented Jul 5, 2023

I am closing this PR as the docs require much more care.

@mvorisek mvorisek closed this Jul 5, 2023
@szepeviktor szepeviktor deleted the patch-1 branch July 5, 2023 19:16
@mvorisek
Copy link
Member

mvorisek commented Jul 16, 2023

@szepeviktor
Copy link
Contributor Author

I wish you good work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants