Re: Restructuring OpenWRT developer documentation

2023-12-11 Thread Javad Rahimipetroudi via openwrt-devel
The sender domain has a DMARC Reject/Quarantine policy which disallows
sending mailing list messages using the original "From" header.

To mitigate this problem, the original message has been wrapped
automatically by the mailing list software.--- Begin Message ---
Dear Rich,
Thanks a lot for your response,
To answer your question:

On Mon, Dec 11, 2023 at 2:42 PM Rich Brown  wrote:
>
> Dear Javad,
>
> First off, I want to thank you for thinking so hard about the OpenWrt 
> Developer Guide. I worked a lot on the user guide back in the LEDE days. 
> Because I wasn't going to be writing code, I never spent much time on the 
> developer guide, and it's terrific to see someone making this effort.
>
> A few questions about your proposal, both for you and for the other 
> developers on this list:
>
> - Are you suggesting simply moving pages from one place in the hierarchy to 
> another?
Yes, At the first steps, we just reconstruct the existing knowledge.
When everything has been placed in the right place, we can add/remove
internal contents of the pages.
> - Or would some/many pages need to be rewritten/split up/combined?
At the moment, not too many pages need to be modified. Just some pages
may be combined.
> - Do you expect to continue using the Dokuwiki system, or converting the 
> content to some other content management system?
As I'm not a maintainer, It really depends on the community.
> - Having invested in this effort, how can we check the result for 
> correctness? (I imagine there are many pages that contain simple, but 
> outdated info.)
We will preserve everything, if it doesn't go well, we can use the old info.
>
> I hope your inquiry kicks off a robust discussion. Thanks again.
>
> Rich Brown

Best Regards,
Javad
>
>
> >
> > Dear OpenWRT developer,
> >
> > I hope this message finds you well. As a user of OpenWRT, I would like
> > to express my appreciation for the excellent work you have done in
> > creating such a comprehensive documentation. However, I have noticed
> > that the current structure can be challenging for new users to
> > navigate, which can be discouraging for them.
> >
> > In an effort to help improve the user experience, I would like to
> > suggest a restructuring scheme based on the Buildroot user manual. I
> > believe that this scheme could make the documentation more accessible
> > and user-friendly, which would in turn help attract more users to
> > OpenWRT.
> >
> > I understand that you have put a lot of effort into creating the
> > documentation, and I want to assure you that my intention is not to
> > criticize your work. Rather, I hope that my suggestion can contribute
> > to the continued success of OpenWRT.
> > The new structure:
> > ---
> > Developer guide
> > * Overview
> > * OpenWRT source code
> >   * Getting the source code
> >   * Working with GitHub
> >   * Revision number calculation
> > * Build system:
> >   * Build System essentials
> >   * System setup
> >  * Linux
> >  * MacOS
> >  * Windows (WSL)
> >   * Setting up a build server in VirtualBox
> >
> > * Build system usage
> >   * Quick image-building guide
> >   * Using build environments
> >   * Overriding Build Options
> >   * Using the SDK
> >   * Cross Compiling your application
> >   * Using External Toolchain
> >   * Image Builder frontends
> >   * Using the Image Builder
> >   * OpenWrt Feeds
> >
> > * Adding new packages to OpenWRT
> >   * "Hello, world!" package for OpenWrt
> >  * Preparing, configuring, and building the necessary tools
> > * Adjusting the PATH variable
> > * Conclusion
> >  * Creating a simple “Hello, world!” application
> > * Creating the source code directory and files
> > * Compiling, linking, and testing the application
> > * Conclusion
> >  * Creating a package from your application
> > * Creating a package feed for your packages
> > * Creating the package manifest file
> > * Conclusion
> >  * Including your package feed into OpenWrt build system
> > * Including the new package feed into the OpenWrt build system
> > * Updating and installing feeds
> > * Conclusion
> >  * Building, deploying and testing your application
> > * Building the package
> > * Deploying and testing your package
> > * Removing your package
> > * Conclusion
> >  * Migrating to use GNU make in your application
> > * Why use GNU make ?
> > * Creating a makefile
> > * Testing the makefile using native tools
> > * Modifying the package manifest, and testing the build
> > * Conclusion
> >  * Patching your application: Adding new files
> > * About patches
> > * Preparing the source code
> > * Creating the first patch
> > * Including the first patch into the package
> > * Conclusion
> >  * Create a sample procd init script
> >  * 

Restructuring OpenWRT documentation

2023-12-11 Thread Javad Rahimipetroudi via openwrt-devel
The sender domain has a DMARC Reject/Quarantine policy which disallows
sending mailing list messages using the original "From" header.

To mitigate this problem, the original message has been wrapped
automatically by the mailing list software.--- Begin Message ---
Dear OpenWRT developer,

I hope this message finds you well. As a user of OpenWRT, I would like
to express my appreciation for the excellent work you have done in
creating such a comprehensive documentation. However, I have noticed
that the current structure can be challenging for new users to
navigate, which can be discouraging for them.

In an effort to help improve the user experience, I would like to
suggest a restructuring scheme based on the Buildroot user manual. I
believe that this scheme could make the documentation more accessible
and user-friendly, which would in turn help attract more users to
OpenWRT.

I understand that you have put a lot of effort into creating the
documentation, and I want to assure you that my intention is not to
criticize your work. Rather, I hope that my suggestion can contribute
to the continued success of OpenWRT.
The new structure:
---
Developer guide
* Overview
* OpenWRT source code
   * Getting the source code
   * Working with GitHub
   * Revision number calculation
* Build system:
   * Build System essentials
   * System setup
  * Linux
  * MacOS
  * Windows (WSL)
   * Setting up a build server in VirtualBox

* Build system usage
   * Quick image-building guide
   * Using build environments
   * Overriding Build Options
   * Using the SDK
   * Cross Compiling your application
   * Using External Toolchain
   * Image Builder frontends
   * Using the Image Builder
   * OpenWrt Feeds

* Adding new packages to OpenWRT
   * "Hello, world!" package for OpenWrt
  * Preparing, configuring, and building the necessary tools
 * Adjusting the PATH variable
 * Conclusion
  * Creating a simple “Hello, world!” application
 * Creating the source code directory and files
 * Compiling, linking, and testing the application
 * Conclusion
  * Creating a package from your application
 * Creating a package feed for your packages
 * Creating the package manifest file
 * Conclusion
  * Including your package feed into OpenWrt build system
 * Including the new package feed into the OpenWrt build system
 * Updating and installing feeds
 * Conclusion
  * Building, deploying and testing your application
 * Building the package
 * Deploying and testing your package
 * Removing your package
 * Conclusion
  * Migrating to use GNU make in your application
 * Why use GNU make ?
 * Creating a makefile
 * Testing the makefile using native tools
 * Modifying the package manifest, and testing the build
 * Conclusion
  * Patching your application: Adding new files
 * About patches
 * Preparing the source code
 * Creating the first patch
 * Including the first patch into the package
 * Conclusion
  * Create a sample procd init script
  * Patching your application: Editing existing files
 * Creating the second patch
 * Conclusion
   * Adding existing packages to OpenWRT
  * Autotools packages
  * Cmake packages
  * Meson packages
  * Packages with other specific build systems
   * Patching a package ( Working with patches)
   * Using Dependencies
* Debugging
   * GNU Debugger
* Device management in OpenWRT
   * Adding a new device
   * Adding new device support
   * Adding new platform support
   * Device support policies / best practices
   * Device Tree Usage in OpenWrt (DTS)
   * Mounting Block Devices
--
Thank you for your consideration.
The full structure is attached.

Best regards,
Javad Rahimipetroudi
Developer guide
* Overview
* OpenWRT source code
   * Getting the source code
   * Working with GitHub
   * Revision number calculation
* Build system:
   * Build System essentials
   * System setup 
  *  Linux
  * MacOS
  * Windows (WSL)
   * Setting up a build server in VirtualBox


* Build system usage
   * Quick image-building guide
   * Using build environments
   * Overriding Build Options
   * Using the SDK
   * Cross Compiling your application
   * Using External Toolchain
   * Image Builder frontends
   * Using the Image Builder
   * OpenWrt Feeds


* Adding new packages to OpenWRT
   * "Hello, world!" package for OpenWrt
  * Preparing, configuring, and building the necessary tools
 * Adjusting the PATH variable
 * Conclusion
  * Creating a simple “Hello, world!” application
 * Creating the source code directory and files
 * Compiling, linking, and testing the application
 * Conclusion
  * Creating a package from your