- 
                Notifications
    
You must be signed in to change notification settings  - Fork 17
 
doc: Updates to Asset tracker template docs #399
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
base: main
Are you sure you want to change the base?
Conversation
28e05ca    to
    cbde2ba      
    Compare
  
    9983f5f    to
    c0c9638      
    Compare
  
            
          
                docs/common/provisioning.md
              
                Outdated
          
        
      | ``` | ||
| 
               | 
          ||
| *Note: Token is printed automatically on first boot of unprovisioned devices.* | ||
| !!! note "Note" | 
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.
I don't think this would render nicely in gh.
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.
Waiting for TechDoc ticket to be resolved.
Same for the below cases.
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.
fixed.
| - [Debugging and troubleshooting](https://academy.nordicsemi.com/courses/nrf-connect-sdk-intermediate/lessons/lesson-2-debugging/) | ||
| - [Cellular IoT Fundamentals Developer Academy Course](https://academy.nordicsemi.com/courses/cellular-iot-fundamentals/) | ||
| - [nRF Connect SDK Debugging Guide](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/test_and_optimize/debugging.html) | ||
| - [Zephyr Debugging Guide](https://docs.zephyrproject.org/latest/develop/debug/index.html) | 
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.
What is the reason for removing the ToC?
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.
This appears to be redundant information in TechDocs because we already have a ToC on the right side of the page in TechDocs - https://docs.nordicsemi.com/bundle/asset-tracker-template-latest/page/common/tooling_troubleshooting.html. But, as it is required for GitHub preview, I have made changes that work for both TechDocs and GitHub.
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.
Used hide CSS style, which will hide the ToC only in Techdoocs.
| CONFIG_NRF_MODEM_LIB_SHELL_TRACE=y | ||
| ``` | ||
| !!! important "Important" | 
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.
Another occurance
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.
fixed.
| JLinkRTTLogger -Device NRF9160_XXAA -If SWD -Speed 50000 -RTTChannel 0 terminal.txt | ||
| ``` | ||
| !!! note "Note" | 
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.
Another
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.
fixed.
| # or follow install [documentation](https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html) | ||
| 
               | 
          ||
| # Install toolchain | ||
| nrfutil toolchain-manager install --ncs-version v3.1.0 | 
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.
I guess this is different now with sdk-manager
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.
sdk-manager toolchain is used in the getting started. Doesnt have to be fixed here, just an FYI. I think both approaches works atm
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.
The content is same as in the readme file - https://github.com/nrfconnect/Asset-Tracker-Template/blob/main/README.md?plain=1#L50.
        
          
                docs/common/getting_started.md
              
                Outdated
          
        
      | ```shell | ||
| *** Booting nRF Connect SDK v3.0.0-3bfc46578e42 *** | ||
| *** Booting nRF Connect SDK v3.1.0-3bfc46578e42 *** | 
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.
This should still show 3.0.0, as the commit 3bfc46578e42 is on that tag and not on 3.1.0. Same below
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.
Revert back the changes.
f82bc5e    to
    9bcb92f      
    Compare
  
    Updates to Asset tracker template docs. Signed-off-by: divya pillai <[email protected]>
9bcb92f    to
    72e0b2a      
    Compare
  
    
Updates to Asset tracker template docs.