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.

Sign up for GitHub

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

Jump to bottom

Documentation: migrate pages from wiki #11127

Open
72 of 100 tasks
raiden00pl opened this issue Nov 4, 2023 · 25 comments
Open
72 of 100 tasks

Documentation: migrate pages from wiki #11127

raiden00pl opened this issue Nov 4, 2023 · 25 comments
Labels
Area: Documentation Improvements or additions to documentation

Comments

@raiden00pl
Copy link
Member

raiden00pl commented Nov 4, 2023 •
edited
Loading

Not all pages below are suitable for migration, some pages are outdated, some are already migrated. Everything listed here for better tracking of the issue.

It's better to have all valuable information in one place (Documentation). Then we can use grep to find all the useful information about a given subject.

Getting Started with NuttX https://cwiki.apache.org/confluence/display/NUTTX/Getting+Started+with+NuttX

  • nothing to migrate

Graphics https://cwiki.apache.org/confluence/display/NUTTX/Graphics

NuttX How-To's https://cwiki.apache.org/confluence/display/NUTTX/NuttX+How-To%27s

Networking https://cwiki.apache.org/confluence/display/NUTTX/Networking

Application/NSH How-To's https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629534

NuttX Implementation/Design https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629479

Platforms https://cwiki.apache.org/confluence/display/NUTTX/Platforms

  • nothing to migrate

Virtual File System https://cwiki.apache.org/confluence/display/NUTTX/Virtual+File+System
@raiden00pl raiden00pl added the Area: Documentation Improvements or additions to documentation label Nov 4, 2023
@raiden00pl raiden00pl mentioned this issue Sep 9, 2024
Merged
@lvanasse
Copy link
Contributor

@raiden00pl would it still be useful to work on the documentation even if it is outdated? I understand that there's not a lot of reason to work on getting outdated documentation in the current documentation format, but I'm thinking it might be difficult to see what is outdated or not. Also, you might need setups to validate how outdated are the pages.

What are your thoughts?

@raiden00pl
Copy link
Member Author

Unless the doc page is completely outdated, porting it still has value, and outdated content can be fixed later.
We can mark such pages with .. warning:: note at the top until they are fixed.

As you mentioned, it can be difficult to determine what is outdated and what isn't, especially for people who haven't been following all the PRs in NuttX over the last few years.

So I'm not sure how we should proceed. Maybe we can just hope that during the PR review process, we'll be able to catch any outdated content and fix it immediately or mark the page as outdated.

@lvanasse
Copy link
Contributor

I was thinking that maybe we should still port everything and as people consult the documentation and try them we'll know if they are outdated.

But I like your idea of adding a warning at the beginning. I'll try to work on some of those pages that are left. Thank you :).

This was referenced Oct 12, 2024
Merged
Merged
Merged
@lvanasse
Copy link
Contributor

@raiden00pl This page: https://cwiki.apache.org/confluence/display/NUTTX/STM32+Null+Pointer+Detection was already migrated :). #14231 Noticed just too late 😅

@lvanasse
Copy link
Contributor

@raiden00pl darn again, very sorry, just notice: https://cwiki.apache.org/confluence/display/NUTTX/STM32+CCM+Allocator also was already migrated 😅

@lvanasse
Copy link
Contributor

@raiden00pl here are 3 other pages to check (once they are merged) :)

#14240 - Kernel Threads with Custom Stacks
#14239 - Versioning and Task Names
#14236 - Using Kernel Threads

Cheers!

@lvanasse
Copy link
Contributor

lvanasse commented Oct 14, 2024 •
edited
Loading

@raiden00pl here are 3 other pages to check (once they are merged) :)

#14274 :

Cheers!

@lvanasse
Copy link
Contributor

@raiden00pl here are 4 other pages to check (once they are merged) :)

#14417 :

  • NuttX Protected Build
  • Integrating with Newlib
  • IPv6
  • Logging to a RAM buffer

Cheers!

@lvanasse
Copy link
Contributor

lvanasse commented Oct 20, 2024 •
edited
Loading

@raiden00pl here are 3 other pages to check (once they are merged) :)

#14419 :

  • Semihosting
  • Porting drivers to stm32f7
  • Platform directories

Cheers!

PS. I'll try to finish the NuttX How-To's section this week :)

@raiden00pl
Copy link
Member Author

great ! thanks for your help :)

@jerpelea
Copy link
Contributor

@raiden00pl thanks for doing it

@lvanasse
Copy link
Contributor

@raiden00pl here are 3 other pages to check (once they are merged) :)

#14522:

  • Signaling Events from Interrupt Handlers
  • Signaling Semaphores and priority inheritance
  • Smaller Vector Tables

(NuttX How-To's done 🥳)

Cheers!

@lvanasse
Copy link
Contributor

lvanasse commented Nov 9, 2024 •
edited
Loading

@raiden00pl here's 4 other pages to check (once they are merged) :)

#14710 :

  • Delayed ACK and TCP Performance
  • TCP Network Performance
  • NxWM Threading
  • Framebuffer Character Driver

(Graphics and Networking section done! Only three more sections to go)

Cheers!

@lvanasse
Copy link
Contributor

lvanasse commented Nov 10, 2024 •
edited
Loading

@raiden00pl, please correct me if I'm wrong, but I think we are missing this page in the list of document to port:

https://cwiki.apache.org/confluence/display/NUTTX/Porting+Guide

I did check in the official wiki, and didn't find it there, and I'm not seeing it in the list when I ctrl+f for it.

Same thing for:

And maybe: https://cwiki.apache.org/confluence/display/NUTTX/User+Guide, but I mean just not know if this has been broken up into sub document.

@lvanasse
Copy link
Contributor

@raiden00pl here are 4 other pages to check (once they are merged) :)

#14714 :

Cheers!

@raiden00pl
Copy link
Member Author

@lvanasse

Doc for "On-Demand Paging" is here https://nuttx.apache.org/docs/latest/components/paging.html
"Porting Guide" and "NuttX Overview" are most likely outdated and I don't know if it makes sense to port them without a proper review.
"User Guide" is probably missing new features, but it should be OK to add.

@lvanasse
Copy link
Contributor

lvanasse commented Dec 28, 2024 •
edited
Loading

@raiden00pl I see that you've written about the SMARTFS in the official documentation. I was wondering if we should to still do the

pages? And if yes, should we put them as supporting pages to the one you've written?

@lvanasse
Copy link
Contributor

@raiden00pl here's 1 other page to check (once they are merged) :)

#15376 :

The two ELF Programs pages weren't in the list, but I couldn't find them inside the official wiki.

Cheers!

@lvanasse
Copy link
Contributor

Another question for @raiden00pl or maybe @acassis since it came from you. It's regarding the page: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629545

It refers to the libc++ of LLVM, but I'm unsure how relevant this page is since we now have the https://nuttx.apache.org/docs/latest/components/libs/libxx.html page inside the official documentation. From reading both it seems that the Confluence page kind of share the repo @acassis made to use the LLVM libc++, and tell me if I'm wrong, but we don't seem to use those actively? It seems to be integrated into the KConfig with CONFIG_LIBCXX=y as per the official documentation is saying.

Anyway, I don't mind migrating it, just didn't want to do redundant work :) If you could please let me know if you still want this page migrated, that would be appreciated :).

@lvanasse
Copy link
Contributor

@raiden00pl here are 9 other pages to check, once merged :)

#15379

  • Building NuttX with Applications Outside the Source Tree
  • Building uClibc++
  • Custom Application Directories
  • Debugging ELF Loadable Modules
  • Multiple NSH Sessions
  • NSH Network Link Management
  • RAM Disks and ROM Disks
  • Reading CAN Messages
  • Removing Device Drivers with NSH

I've also stumbled upon the https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629410 I was wondering if it should also be added to the list, it seems very interesting.

Also, that PR concluded the NSH How-To's :)!

Cheers!

@acassis
Copy link
Contributor

acassis commented Dec 31, 2024

@lvanasse that page is very old and as you noticed LLVM C++ is already integrated into mainline. I suggest removing it or creating a new page explaining how to use LLVM C++ nowadays.

@lvanasse
Copy link
Contributor

lvanasse commented Jan 4, 2025

@acassis I'm not too sure what would be the content of how to use LLVM C++ nowadays page to be honest 😥, so I'm hesitant to make a call.

@acassis
Copy link
Contributor

acassis commented Jan 5, 2025

@lvanasse yes, since the integration is transparent now, there is not much to document

@lvanasse
Copy link
Contributor

lvanasse commented Jan 5, 2025

@raiden00pl I see that you've written about the SMARTFS in the official documentation. I was wondering if we should to still do the

* https://cwiki.apache.org/confluence/display/NUTTX/Using+SmartFS

* https://cwiki.apache.org/confluence/display/NUTTX/SmartFS+Internals

pages? And if yes, should we put them as supporting pages to the one you've written?

@raiden00pl any input :)?

@raiden00pl
Copy link
Member Author

This page was migrated from the old README which was in fs/ (removed here 5b87fdf). I think we should add SmartFS Internals to the current SmartFS page add Using SmartFS to the Guids page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area: Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@acassis @raiden00pl @jerpelea @lvanasse