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

Doc fixes #3333

Merged
merged 7 commits into from
Nov 25, 2020
Merged

Doc fixes #3333

merged 7 commits into from
Nov 25, 2020

Conversation

HHHartmann
Copy link
Member

@HHHartmann HHHartmann commented Nov 22, 2020

Fixes #no issue.

  • This PR is for the dev branch rather than for the release branch.
  • This PR is compliant with the other contributing guidelines as well (if not, please describe why).
  • I have thoroughly tested my contribution.
  • The code changes are reflected in the documentation at docs/*.

<Description of and rationale behind this PR>
Fix doxumentation:

  • include windows luac.cross attached to releases in the tools matrix
  • fix minimal LFS example
  • fix example in docs/index.md
  • change master -> release

@marcelstoer marcelstoer added this to the Next release milestone Nov 22, 2020
@@ -146,7 +151,7 @@ For everything else the cloud builder GUI is self-explanatory. Hence, no need fo
1. Select an LFS size, 64KB is likely going to be large enough
1. Select other options and build

[↑ back to matrix](#task-os-selector)
[↑ back to matrix](#task--os-selector)
Copy link
Member

Choose a reason for hiding this comment

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

That's possibly fixing a non-existent bug, see https://nodemcu.readthedocs.io/en/latest/getting-started/#task-os-selector

-> #task-os-selector

In case GitHub and RTD use different to-anchor algorithms (caused by the '/' ?) then maybe we need to adjust the title.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops, should have checked at RTD. changed the title.

Copy link
Member Author

Choose a reason for hiding this comment

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

Btw: is there a way to check RTD before at least having it on dev branch?
Btw2: Have you seen the PR number?

Copy link
Member

Choose a reason for hiding this comment

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

Btw: is there a way to check RTD before at least having it on dev branch?

Two options:

  • Create a RTD account for yourself and create a project pointing at your forked NodeMCU repo.
  • Install MkDocs locally and run mkdocs serve in the NodeMCU root (ignoring the warnings about invalid source code references). Question is: which MkDocs version? I lost track.

Btw2: Have you seen the PR number?

😄 not until you mentioned it, congrats for pulling a repdigit ticket number

docs/getting-started.md Show resolved Hide resolved
@nwf
Copy link
Member

nwf commented Nov 23, 2020

There are a number of /master/ URLs in README.md that could stand to be modernized while you're here.

@vsky279
Copy link
Contributor

vsky279 commented Nov 23, 2020

@HHHartmann Gregor, I suggested few other corrections sending a PR directly to your branch.

Copy link
Member

@nwf nwf left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@marcelstoer marcelstoer merged commit 63d8213 into nodemcu:dev Nov 25, 2020
@HHHartmann HHHartmann deleted the Doc-fixes branch January 3, 2021 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants