-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
Doc fixes #3333
Conversation
docs/getting-started.md
Outdated
@@ -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) |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There are a number of |
@HHHartmann Gregor, I suggested few other corrections sending a PR directly to your branch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Fixes #no issue.
dev
branch rather than for therelease
branch.docs/*
.<Description of and rationale behind this PR>
Fix doxumentation: