Skip to content

md to rst #3704

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 1 commit into from
Oct 15, 2017
Merged

md to rst #3704

merged 1 commit into from
Oct 15, 2017

Conversation

bscheshir
Copy link
Contributor

actual instructions in rst

fixed #3689

actual instructions in rst
@devyte
Copy link
Collaborator

devyte commented Oct 11, 2017

@igrr this fixes the links to the docs. Do we want that, or do we want to migrate the docs to markdown, or do we want both?

@igrr
Copy link
Member

igrr commented Oct 11, 2017

@devyte Well the docs have been migrated from .md to .rst recently to be able to use readthedocs, so we just want to fix the remaining broken links.

@bscheshir Thank you for the fix. Do you think that pointing to HTML docs will be nicer/more useful? E.g. http://arduino-esp8266.readthedocs.io/en/latest/Troubleshooting/debugging.html.
If yes, would you mind amending your commit?

@bscheshir
Copy link
Contributor Author

bscheshir commented Oct 11, 2017

@igrr
Copy link
Member

igrr commented Oct 11, 2017

"latest" on readthedocs is automatically built from master on each commit. To get docs for tagged version (e.g. v2.4.0-rc1), replace "latest" with the tag name.

@bscheshir
Copy link
Contributor Author

So... I think is arduino-esp8266.readthedocs.io have a good design, but https://github.com/esp8266/Arduino is a same host with repo, I think more people trust github.

I vote for github 😺

@igrr igrr merged commit 93ad1fb into esp8266:master Oct 15, 2017
d-a-v pushed a commit to d-a-v/Arduino that referenced this pull request Oct 15, 2017
actual instructions in rst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

.md -> .rst in "new issue" pattern
3 participants