<div dir="ltr"><div><div>Yes, this makes sense. I've read through the Documentation<br>guidelines and have started writing a document for the tool.<br></div><div>However, I have a couple questions.<br></div><br>Where should the new document be created?<br>Also, should I create a "doc/api" directory and include files to<br>build the documentation?<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jan 16, 2024 at 9:10 AM Aaron Conole <<a href="mailto:aconole@redhat.com">aconole@redhat.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Adam Hassick <<a href="mailto:ahassick@iol.unh.edu" target="_blank">ahassick@iol.unh.edu</a>> writes:<br>
<br>
> On Wed, Jan 10, 2024 at 11:54 AM Aaron Conole <<a href="mailto:aconole@redhat.com" target="_blank">aconole@redhat.com</a>> wrote:<br>
><br>
>  Adam Hassick <<a href="mailto:ahassick@iol.unh.edu" target="_blank">ahassick@iol.unh.edu</a>> writes:<br>
><br>
>  > This script takes in a URL to a series on Patchwork and emits a<br>
>  > tarball which may be used for running tests.<br>
>  ><br>
>  > Signed-off-by: Adam Hassick <<a href="mailto:ahassick@iol.unh.edu" target="_blank">ahassick@iol.unh.edu</a>><br>
>  > ---<br>
><br>
>  Just a quick glance.<br>
><br>
>  Is it possible to include a doc on how it is expected to run this<br>
>  script?  Maybe that could help to also evaluate it as well.<br>
><br>
> Is there a location in or outside of this repository where<br>
> documentation on tools should be submitted? I have included<br>
> a brief description in the text displayed when the "--help" flag<br>
> is passed in, and in v2 this will include an example.<br>
<br>
I think just make a doc/ directory and add a .rst for this tool<br>
(something like we would do for manpages).  I know this is a new thing<br>
that we haven't required in the past, but the project is now growing to<br>
the point that we should have a bit of knowledge shared around.<br>
<br>
Does it make sense?<br>
<br>
</blockquote></div>