Blame Manuals/Docbook/Repository/Usage/section-4-2.docbook

e935c3
e935c3
<section>
e935c3
e935c3
    <title>Documentation</title>
e935c3
e935c3
    <para>The documentation work line exists to describe what each
e935c3
    directory inside the CentOS Artwork Repository is for, the
e935c3
    conceptual ideas behind them and, if possible, how automation
e935c3
    scripts make use of them.</para>
e935c3
    
e935c3
    <para>The CentOS Artwork Repository documentation is supported by
e935c3
    Texinfo, a documentation system that uses a single source file to
e935c3
    produce both online information and printed output.</para>
e935c3
    
e935c3
    <para>The repository documentation is organized under
e935c3
    @file{trunk/Manual} directory and uses the repository directory
e935c3
    structre as reference.  Each directory in the repository has a
e935c3
    documentation entry associated in the documentation manual.
e935c3
    Documentation entries are stored under
e935c3
    @file{trunk/Manual/Directories} directory and the action itself is
e935c3
    controlled by the @code{help} functionality of
e935c3
    <command>centos-art.sh</command> script.</para>
e935c3
    
e935c3
    <para>The @code{help} functionality let you create, edit and
e935c3
    delete documentation entries in a way that you don't need to take
e935c3
    care of updating menus, nodes and cross reference information
e935c3
    inside the manual structure; the functionality takes care of it
e935c3
    for you.  However, if you need to write repository documentation
e935c3
    that have nothing to do with repository directories (e.g.,
e935c3
    Preface, Introduction and similar) you need to do it manually,
e935c3
    there is no functionality to automate such process yet.</para>
e935c3
    
e935c3
    <para>@xref{Directories trunk Manual}, for more information on
e935c3
    documentation.</para>
e935c3
    
e935c3
</section>