You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2021/04/14 16:51:37 UTC

[GitHub] [incubator-nuttx] acassis opened a new pull request #3547: Documentation: Add FAQ entry

acassis opened a new pull request #3547:
URL: https://github.com/apache/incubator-nuttx/pull/3547


   ## Summary
   Add FAQ entry to Documentation
   ## Impact
   User will get a FAQ in the Documentation
   ## Testing
   N/A
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-nuttx] v01d commented on a change in pull request #3547: Documentation: Add FAQ entry

Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #3547:
URL: https://github.com/apache/incubator-nuttx/pull/3547#discussion_r613419457



##########
File path: Documentation/index.rst
##########
@@ -27,6 +27,7 @@ Last Updated: |today|
    components/index.rst
    applications/index.rst
    reference/index.rst
+   faq.rst

Review comment:
       please move into `faq/index.rst` so that we can later split into subdocuments as needed




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-nuttx] acassis commented on a change in pull request #3547: Documentation: Add FAQ entry

Posted by GitBox <gi...@apache.org>.
acassis commented on a change in pull request #3547:
URL: https://github.com/apache/incubator-nuttx/pull/3547#discussion_r613460948



##########
File path: Documentation/index.rst
##########
@@ -27,6 +27,7 @@ Last Updated: |today|
    components/index.rst
    applications/index.rst
    reference/index.rst
+   faq.rst

Review comment:
       Thank you @v01d all issues were fixed!




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-nuttx] v01d commented on a change in pull request #3547: Documentation: Add FAQ entry

Posted by GitBox <gi...@apache.org>.
v01d commented on a change in pull request #3547:
URL: https://github.com/apache/incubator-nuttx/pull/3547#discussion_r613418418



##########
File path: Documentation/faq.rst
##########
@@ -0,0 +1,35 @@
+.. todo::
+  Create new subsections as needed.
+
+===
+FAQ
+===
+
+NSH Tricks
+==========
+
+  How to enable interrupt an NSH Application using Ctrl^C ?

Review comment:
       Each question should be in separate subsection. Use `-` underline.
   Also, for key indications and menuconfig entries use the roles mentioned here: https://nuttx.apache.org/docs/latest/contributing/documentation.html#user-indications




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-nuttx] v01d merged pull request #3547: Documentation: Add FAQ entry

Posted by GitBox <gi...@apache.org>.
v01d merged pull request #3547:
URL: https://github.com/apache/incubator-nuttx/pull/3547


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org