You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nuttx.apache.org by TimH <ti...@jti.uk.com.INVALID> on 2022/10/07 15:58:57 UTC
[apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
As per request below, I’m happy to add a paragraph or two regarding this, but I am not sure where it should go?
It could be a section in “guides” or I could add it to the FAQ. What is preferred, assuming the Documentation folder in the repo is actually the right place for this of course?
Related to this, what is the significance of the cwiki (https://cwiki.apache.org/confluence/display/NUTTX) as that has a lot more information in it compared to the Nuttx distro’s Documentation folder, but is outdated and perhaps not maintained I think? The cwiki has information on custom app directory usage that could either be a source of info for a more complete “custom environment” guide or is the actually the intended place for the custom boards info I’ve been asked to add?
TIA,
TimH
From: hartmannathan <no...@github.com>
Sent: 22 September 2022 15:00
@TimJTi <https://github.com/TimJTi> :
Bear in mind that a distclean will wipe .config so any settings of paths etc. there become irrelevant…that’s what “did me in”!
I don't think we have good documentation on how to do custom-out-of-tree boards. Since you're working with an out-of-tree board, would you be willing to write something helpful for including in Documentation? It wouldn't have to be super long and detailed, just how to invoke the configure.sh script, which Kconfig options to set, and gotchas to avoid like distclean wiping the .config!
—
Reply to this email directly, view it on GitHub <https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1255066777> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANQZJKNGKLF5PVP4I7SQESTV7RQ45ANCNFSM6AAAAAAQNUBOU4> .
You are receiving this because you were mentioned. <https://github.com/notifications/beacon/ANQZJKI4BDY4LRTNDNARIJDV7RQ45A5CNFSM6AAAAAAQNUBOU6WGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTSKZ3GJS.gif> Message ID: <apache/incubator-nuttx/pull/7103/c1255066777@github.com <ma...@github.com> >
Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by Nathan Hartman <ha...@gmail.com>.
On Fri, Oct 7, 2022 at 12:25 PM TimH <ti...@jti.uk.com.invalid> wrote:
>
> Got it - thanks Nathan. I will probably plunder some text from the cwiki then, and not feel guilty :-)
Sure thing -- feel free to do that!!! :-)
Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by TimH <Ti...@jti.uk.com.INVALID>.
Hmmm…no, I’ll rummage around to find out how to do that as it sounds like what I’m looking for, thanks.
> On 11 Oct 2022, at 19:27, Abdelatif Guettouche <ab...@gmail.com> wrote:
>
> Did you check the "external" directory or are you looking for something
> else?
>
> Basically the external directory allows you to symlink an out of tree
> repository (or repositories) that should contain, at least, the minimal
> build glues (Makefile and Make.defs). The build system should pick up the
> rest.
> The external directory is ignored from the tracking system so nothing
> impacts the actual apps repo.
>
>> On Tue, Oct 11, 2022 at 8:07 PM Tim Hardisty <ti...@jti.uk.com.invalid>
>> wrote:
>>
>> I have walked through the custom apps guide from the cwiki and find that
>> it is explaining how to replace the ENTIRE Nuttx Apps directory with a
>> custom alternative.
>>
>> That seems to me to be perhaps of minority interest but I'll include it in
>> the documentation I'm writing anyway for completeness.
>>
>> But is there a way to add a custom folder - in or out of tree - that will
>> be included along with the built-in apps and examples? This would allow you
>> to include custom appss, and the built-in ones, but not have a problem when
>> merging future releases that might cause the building in of the custom apps
>> to fail?
>>
>> Perhaps I'm over thinking it?
>>
>> On 07/10/2022, 17:25, "TimH" <ti...@jti.uk.com.INVALID> wrote:
>>
>> Got it - thanks Nathan. I will probably plunder some text from the
>> cwiki then, and not feel guilty :-)
>>
>>> -----Original Message-----
>>> From: Nathan Hartman <ha...@gmail.com>
>>> Sent: 07 October 2022 17:23
>>> To: dev@nuttx.apache.org
>>> Subject: Re: [apache/incubator-nuttx] tools/configure.sh: Update
>> USAGE for
>>> custom out-of-tree boards (PR #7103)
>>>
>>> On Fri, Oct 7, 2022 at 11:59 AM TimH <ti...@jti.uk.com.invalid> wrote:
>>>>
>>>> As per request below, I’m happy to add a paragraph or two regarding
>> this,
>>> but I am not sure where it should go?
>>>>
>>>> It could be a section in “guides” or I could add it to the FAQ.
>> What is
>>> preferred, assuming the Documentation folder in the repo is actually
>> the right
>>> place for this of course?
>>>
>>> I think it would best fit in guides under the Documentation folder in
>> the repo,
>>> and I think that's where all "official" documentation should
>> ultimately be.
>>>
>>>> Related to this, what is the significance of the cwiki
>>> (https://cwiki.apache.org/confluence/display/NUTTX) as that has a
>> lot more
>>> information in it compared to the Nuttx distro’s Documentation
>> folder, but is
>>> outdated and perhaps not maintained I think? The cwiki has
>> information on
>>> custom app directory usage that could either be a source of info for
>> a more
>>> complete “custom environment” guide or is the actually the intended
>> place
>>> for the custom boards info I’ve been asked to add?
>>>
>>> From my memory, before NuttX joined the Apache.org Incubator, what's
>> now
>>> in the CWIKI was in a MediaWiki on the NuttX website. When we joined
>> the
>>> Incubator, this was somehow migrated to the Apache.org CWIKI. Some (or
>>> most?) of it was then migrated again into what is now the
>> Documentation
>>> folder in the repo. However, there are some differences between the
>> two
>>> because new documentation has been written under Documentation while
>>> some of the docs available in the CWIKI may not have been migrated,
>> and I
>>> think there are still articles in the CWIKI that have not made it into
>>> Documentation.
>>>
>>> As to what's the purpose of the CWIKI: Some time ago, I asked whether
>> we
>>> should keep the CWIKI around. Now I can't seem to locate that email
>> after a
>>> quick search, but as I remember, a few people said they would like to
>> keep
>>> the CWIKI as a place to collaborate on documentation, as it makes
>> real-time
>>> collaborative writing easier (without the added friction of making
>> PRs) and
>>> then migrate finished documents into Documentation.
>>>
>>> In short, there's some work yet to be done on documentation and it
>> isn't a
>>> secret that we, like probably most community-driven projects, need
>> lots of
>>> help improving our documentation!!!
>>>
>>> Hope that helps. I'd like to say a sincere THANK YOU for any
>> improvements
>>> you're willing to make, large or small!
>>>
>>> Cheers,
>>> Nathan
>>
>>
>>
>>
RE: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by Gregory Nutt <sp...@gmail.com>.
> If external is historic, what is the preferred way to include a custom
out-of-tree (i.e. non-public) App in a build, in a way that won't get
trashed if a distclean or Nuttx upgrade merge is done?
Distclean will not affect any untracked files/directories/symbolic links.
If an untracked directory contains a Makefile, distclean should also call
the distclean target in the directory. A git pull should not affect the
untracked directory.
Although it is an older solution and mostly redundant, use of the
"external" directory is not discouraged.
Differences:
- There can be only one external directory
- The external directory will not show up as untracked if you do 'git
status'
- You have to configure other directories first before the first make.
That is when the directories are configured into the build. External is
supported by hard-coded logic in the build and does not need to be
configured.
Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by Tim Hardisty <ti...@jti.uk.com.INVALID>.
If external is historic, what is the preferred way to include a custom out-of-tree (i.e. non-public) App in a build, in a way that won't get trashed if a distclean or Nuttx upgrade merge is done?
On 11/10/2022, 20:08, "Gregory Nutt" <sp...@gmail.com> wrote:
> Did you check the "external" directory or are you looking for something
> else?
>
> Basically the external directory allows you to symlink an out of tree
> repository (or repositories) that should contain, at least, the minimal
> build glues (Makefile and Make.defs). The build system should pick up the
> rest.
> The external directory is ignored from the tracking system so nothing
> impacts the actual apps repo.
The "external" directory is typically a symbolic link. It is mostly of
historical interest because you can place any symbolic link to an
external directory (or directories) containing a Kconfig and Makefile
in the apps/ directory and it (or they) will be built. The only thing
special about the "external" directory is that it is properly ignored in
apps/.gitignore
Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by Gregory Nutt <sp...@gmail.com>.
> Did you check the "external" directory or are you looking for something
> else?
>
> Basically the external directory allows you to symlink an out of tree
> repository (or repositories) that should contain, at least, the minimal
> build glues (Makefile and Make.defs). The build system should pick up the
> rest.
> The external directory is ignored from the tracking system so nothing
> impacts the actual apps repo.
The "external" directory is typically a symbolic link. It is mostly of
historical interest because you can place any symbolic link to an
external directory (or directories) containing a Kconfig and Makefile
in the apps/ directory and it (or they) will be built. The only thing
special about the "external" directory is that it is properly ignored in
apps/.gitignore
Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by Abdelatif Guettouche <ab...@gmail.com>.
Did you check the "external" directory or are you looking for something
else?
Basically the external directory allows you to symlink an out of tree
repository (or repositories) that should contain, at least, the minimal
build glues (Makefile and Make.defs). The build system should pick up the
rest.
The external directory is ignored from the tracking system so nothing
impacts the actual apps repo.
On Tue, Oct 11, 2022 at 8:07 PM Tim Hardisty <ti...@jti.uk.com.invalid>
wrote:
> I have walked through the custom apps guide from the cwiki and find that
> it is explaining how to replace the ENTIRE Nuttx Apps directory with a
> custom alternative.
>
> That seems to me to be perhaps of minority interest but I'll include it in
> the documentation I'm writing anyway for completeness.
>
> But is there a way to add a custom folder - in or out of tree - that will
> be included along with the built-in apps and examples? This would allow you
> to include custom appss, and the built-in ones, but not have a problem when
> merging future releases that might cause the building in of the custom apps
> to fail?
>
> Perhaps I'm over thinking it?
>
> On 07/10/2022, 17:25, "TimH" <ti...@jti.uk.com.INVALID> wrote:
>
> Got it - thanks Nathan. I will probably plunder some text from the
> cwiki then, and not feel guilty :-)
>
> >-----Original Message-----
> >From: Nathan Hartman <ha...@gmail.com>
> >Sent: 07 October 2022 17:23
> >To: dev@nuttx.apache.org
> >Subject: Re: [apache/incubator-nuttx] tools/configure.sh: Update
> USAGE for
> >custom out-of-tree boards (PR #7103)
> >
> >On Fri, Oct 7, 2022 at 11:59 AM TimH <ti...@jti.uk.com.invalid> wrote:
> >>
> >> As per request below, I’m happy to add a paragraph or two regarding
> this,
> >but I am not sure where it should go?
> >>
> >> It could be a section in “guides” or I could add it to the FAQ.
> What is
> >preferred, assuming the Documentation folder in the repo is actually
> the right
> >place for this of course?
> >
> >I think it would best fit in guides under the Documentation folder in
> the repo,
> >and I think that's where all "official" documentation should
> ultimately be.
> >
> >> Related to this, what is the significance of the cwiki
> >(https://cwiki.apache.org/confluence/display/NUTTX) as that has a
> lot more
> >information in it compared to the Nuttx distro’s Documentation
> folder, but is
> >outdated and perhaps not maintained I think? The cwiki has
> information on
> >custom app directory usage that could either be a source of info for
> a more
> >complete “custom environment” guide or is the actually the intended
> place
> >for the custom boards info I’ve been asked to add?
> >
> >From my memory, before NuttX joined the Apache.org Incubator, what's
> now
> >in the CWIKI was in a MediaWiki on the NuttX website. When we joined
> the
> >Incubator, this was somehow migrated to the Apache.org CWIKI. Some (or
> >most?) of it was then migrated again into what is now the
> Documentation
> >folder in the repo. However, there are some differences between the
> two
> >because new documentation has been written under Documentation while
> >some of the docs available in the CWIKI may not have been migrated,
> and I
> >think there are still articles in the CWIKI that have not made it into
> >Documentation.
> >
> >As to what's the purpose of the CWIKI: Some time ago, I asked whether
> we
> >should keep the CWIKI around. Now I can't seem to locate that email
> after a
> >quick search, but as I remember, a few people said they would like to
> keep
> >the CWIKI as a place to collaborate on documentation, as it makes
> real-time
> >collaborative writing easier (without the added friction of making
> PRs) and
> >then migrate finished documents into Documentation.
> >
> >In short, there's some work yet to be done on documentation and it
> isn't a
> >secret that we, like probably most community-driven projects, need
> lots of
> >help improving our documentation!!!
> >
> >Hope that helps. I'd like to say a sincere THANK YOU for any
> improvements
> >you're willing to make, large or small!
> >
> >Cheers,
> >Nathan
>
>
>
>
Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by Tim Hardisty <ti...@jti.uk.com.INVALID>.
I have walked through the custom apps guide from the cwiki and find that it is explaining how to replace the ENTIRE Nuttx Apps directory with a custom alternative.
That seems to me to be perhaps of minority interest but I'll include it in the documentation I'm writing anyway for completeness.
But is there a way to add a custom folder - in or out of tree - that will be included along with the built-in apps and examples? This would allow you to include custom appss, and the built-in ones, but not have a problem when merging future releases that might cause the building in of the custom apps to fail?
Perhaps I'm over thinking it?
On 07/10/2022, 17:25, "TimH" <ti...@jti.uk.com.INVALID> wrote:
Got it - thanks Nathan. I will probably plunder some text from the cwiki then, and not feel guilty :-)
>-----Original Message-----
>From: Nathan Hartman <ha...@gmail.com>
>Sent: 07 October 2022 17:23
>To: dev@nuttx.apache.org
>Subject: Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for
>custom out-of-tree boards (PR #7103)
>
>On Fri, Oct 7, 2022 at 11:59 AM TimH <ti...@jti.uk.com.invalid> wrote:
>>
>> As per request below, I’m happy to add a paragraph or two regarding this,
>but I am not sure where it should go?
>>
>> It could be a section in “guides” or I could add it to the FAQ. What is
>preferred, assuming the Documentation folder in the repo is actually the right
>place for this of course?
>
>I think it would best fit in guides under the Documentation folder in the repo,
>and I think that's where all "official" documentation should ultimately be.
>
>> Related to this, what is the significance of the cwiki
>(https://cwiki.apache.org/confluence/display/NUTTX) as that has a lot more
>information in it compared to the Nuttx distro’s Documentation folder, but is
>outdated and perhaps not maintained I think? The cwiki has information on
>custom app directory usage that could either be a source of info for a more
>complete “custom environment” guide or is the actually the intended place
>for the custom boards info I’ve been asked to add?
>
>From my memory, before NuttX joined the Apache.org Incubator, what's now
>in the CWIKI was in a MediaWiki on the NuttX website. When we joined the
>Incubator, this was somehow migrated to the Apache.org CWIKI. Some (or
>most?) of it was then migrated again into what is now the Documentation
>folder in the repo. However, there are some differences between the two
>because new documentation has been written under Documentation while
>some of the docs available in the CWIKI may not have been migrated, and I
>think there are still articles in the CWIKI that have not made it into
>Documentation.
>
>As to what's the purpose of the CWIKI: Some time ago, I asked whether we
>should keep the CWIKI around. Now I can't seem to locate that email after a
>quick search, but as I remember, a few people said they would like to keep
>the CWIKI as a place to collaborate on documentation, as it makes real-time
>collaborative writing easier (without the added friction of making PRs) and
>then migrate finished documents into Documentation.
>
>In short, there's some work yet to be done on documentation and it isn't a
>secret that we, like probably most community-driven projects, need lots of
>help improving our documentation!!!
>
>Hope that helps. I'd like to say a sincere THANK YOU for any improvements
>you're willing to make, large or small!
>
>Cheers,
>Nathan
RE: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by TimH <ti...@jti.uk.com.INVALID>.
Short term, I've cloned apache:master afresh, copied my new files to that, then committed it to a new branch in my own fork. No idea if that's the right thing to have done, but the PR is now live, at least!
>-----Original Message-----
>From: TimH <ti...@jti.uk.com.INVALID>
>Sent: 12 October 2022 16:00
>To: dev@nuttx.apache.org
>Subject: RE: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for
>custom out-of-tree boards (PR #7103)
>
>I have created 2 rst files to document out-of-tree custom boards, and also
>how to manage custom apps both in and out of tree, and would like to submit
>a PR.
>
>This will be the first time I have submitted a PR, and I'm fairly new to using GIT
>and I'm struggling to understand the (documented) workflow as I just can't
>relate to it.
>
>Here is the history of my interactions with the repositories.
>
>1) I originally created a fork of the main incubator-nuttx repo, sometime back
>in 2021, from the 10.1 release branch.
>2) I have created various branches along the way and committed my changes
>to my own forked repo
>3) My current branch includes a merge of 11.0 RC2
>4) My "master" is 5000+ commits behind apache:master, not surprisingly
>5) My current active branch is around 500 commits behind apache:master
>6) I have not pulled/merged my own branch to my "master" as github says it
>can't do an automatic merge.
>5) I can't do a PR back to apache:master from my active branch because, um, it
>confuses me!
>
>Can a Nuttx/GIT old-hand offer some guidance on how I get out of this
>seeming muddle so I can get myself in a position to submit PRs? I have other
>code I would like to contribute so have to get this sorted, but, equally, don't
>want to mess up my ongoing development work by having to pulling in
>"random" current patches from apache:master that might break what I'm
>doing (i.e. I want to be in control of what master branch/release my work is
>based on).
>
>Hope that makes sense?
RE: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by TimH <ti...@jti.uk.com.INVALID>.
I have created 2 rst files to document out-of-tree custom boards, and also how to manage custom apps both in and out of tree, and would like to submit a PR.
This will be the first time I have submitted a PR, and I'm fairly new to using GIT and I'm struggling to understand the (documented) workflow as I just can't relate to it.
Here is the history of my interactions with the repositories.
1) I originally created a fork of the main incubator-nuttx repo, sometime back in 2021, from the 10.1 release branch.
2) I have created various branches along the way and committed my changes to my own forked repo
3) My current branch includes a merge of 11.0 RC2
4) My "master" is 5000+ commits behind apache:master, not surprisingly
5) My current active branch is around 500 commits behind apache:master
6) I have not pulled/merged my own branch to my "master" as github says it can't do an automatic merge.
5) I can't do a PR back to apache:master from my active branch because, um, it confuses me!
Can a Nuttx/GIT old-hand offer some guidance on how I get out of this seeming muddle so I can get myself in a position to submit PRs? I have other code I would like to contribute so have to get this sorted, but, equally, don't want to mess up my ongoing development work by having to pulling in "random" current patches from apache:master that might break what I'm doing (i.e. I want to be in control of what master branch/release my work is based on).
Hope that makes sense?
RE: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by TimH <ti...@jti.uk.com.INVALID>.
Got it - thanks Nathan. I will probably plunder some text from the cwiki then, and not feel guilty :-)
>-----Original Message-----
>From: Nathan Hartman <ha...@gmail.com>
>Sent: 07 October 2022 17:23
>To: dev@nuttx.apache.org
>Subject: Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for
>custom out-of-tree boards (PR #7103)
>
>On Fri, Oct 7, 2022 at 11:59 AM TimH <ti...@jti.uk.com.invalid> wrote:
>>
>> As per request below, I’m happy to add a paragraph or two regarding this,
>but I am not sure where it should go?
>>
>> It could be a section in “guides” or I could add it to the FAQ. What is
>preferred, assuming the Documentation folder in the repo is actually the right
>place for this of course?
>
>I think it would best fit in guides under the Documentation folder in the repo,
>and I think that's where all "official" documentation should ultimately be.
>
>> Related to this, what is the significance of the cwiki
>(https://cwiki.apache.org/confluence/display/NUTTX) as that has a lot more
>information in it compared to the Nuttx distro’s Documentation folder, but is
>outdated and perhaps not maintained I think? The cwiki has information on
>custom app directory usage that could either be a source of info for a more
>complete “custom environment” guide or is the actually the intended place
>for the custom boards info I’ve been asked to add?
>
>From my memory, before NuttX joined the Apache.org Incubator, what's now
>in the CWIKI was in a MediaWiki on the NuttX website. When we joined the
>Incubator, this was somehow migrated to the Apache.org CWIKI. Some (or
>most?) of it was then migrated again into what is now the Documentation
>folder in the repo. However, there are some differences between the two
>because new documentation has been written under Documentation while
>some of the docs available in the CWIKI may not have been migrated, and I
>think there are still articles in the CWIKI that have not made it into
>Documentation.
>
>As to what's the purpose of the CWIKI: Some time ago, I asked whether we
>should keep the CWIKI around. Now I can't seem to locate that email after a
>quick search, but as I remember, a few people said they would like to keep
>the CWIKI as a place to collaborate on documentation, as it makes real-time
>collaborative writing easier (without the added friction of making PRs) and
>then migrate finished documents into Documentation.
>
>In short, there's some work yet to be done on documentation and it isn't a
>secret that we, like probably most community-driven projects, need lots of
>help improving our documentation!!!
>
>Hope that helps. I'd like to say a sincere THANK YOU for any improvements
>you're willing to make, large or small!
>
>Cheers,
>Nathan
Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
Posted by Nathan Hartman <ha...@gmail.com>.
On Fri, Oct 7, 2022 at 11:59 AM TimH <ti...@jti.uk.com.invalid> wrote:
>
> As per request below, I’m happy to add a paragraph or two regarding this, but I am not sure where it should go?
>
> It could be a section in “guides” or I could add it to the FAQ. What is preferred, assuming the Documentation folder in the repo is actually the right place for this of course?
I think it would best fit in guides under the Documentation folder in
the repo, and I think that's where all "official" documentation should
ultimately be.
> Related to this, what is the significance of the cwiki (https://cwiki.apache.org/confluence/display/NUTTX) as that has a lot more information in it compared to the Nuttx distro’s Documentation folder, but is outdated and perhaps not maintained I think? The cwiki has information on custom app directory usage that could either be a source of info for a more complete “custom environment” guide or is the actually the intended place for the custom boards info I’ve been asked to add?
From my memory, before NuttX joined the Apache.org Incubator, what's
now in the CWIKI was in a MediaWiki on the NuttX website. When we
joined the Incubator, this was somehow migrated to the Apache.org
CWIKI. Some (or most?) of it was then migrated again into what is now
the Documentation folder in the repo. However, there are some
differences between the two because new documentation has been written
under Documentation while some of the docs available in the CWIKI may
not have been migrated, and I think there are still articles in the
CWIKI that have not made it into Documentation.
As to what's the purpose of the CWIKI: Some time ago, I asked whether
we should keep the CWIKI around. Now I can't seem to locate that email
after a quick search, but as I remember, a few people said they would
like to keep the CWIKI as a place to collaborate on documentation, as
it makes real-time collaborative writing easier (without the added
friction of making PRs) and then migrate finished documents into
Documentation.
In short, there's some work yet to be done on documentation and it
isn't a secret that we, like probably most community-driven projects,
need lots of help improving our documentation!!!
Hope that helps. I'd like to say a sincere THANK YOU for any
improvements you're willing to make, large or small!
Cheers,
Nathan