Re: Documenting our source code structure

2024-05-23 Thread Arrigo Marchiori
Hello All,

On Thu, May 16, 2024 at 03:19:23PM +, Damjan Jovanovic wrote:

> On Thu, May 16, 2024 at 2:41 PM Matthias Seidel 
> wrote:
> 
> > Hi All,
> >
> > Some time ago I added some rudimentary Readme to some directories in our
> > code, e.g.:
> >
> > https://github.com/apache/openoffice/edit/trunk/main/sw/README.md
> >
> > Please feel encouraged to add more information to describe what a
> > specific directory is meant for.
> >
> > Of course, this is a work in progress, but it would help volunteers to
> > understand our code better.
> >
> > In this case, who should know, that "sw" stands for "StarWriter" and
> > contains the code for the "Writer" part of our software?
> >
> > Opinions?
> >
>
> Please note we already have other sources of info that could be used for
> these files,

Until now, I have used this wiki page:
https://wiki.openoffice.org/wiki/Source_code_directories
to get a first idea of what is inside the directories.

> eg. in the  tag of some modules' xml files, such
> as main/sw/xml/writer.xml

Nice! Is that information used anywhere?

Best regards,
-- 
Arrigo

-
To unsubscribe, e-mail: dev-unsubscr...@openoffice.apache.org
For additional commands, e-mail: dev-h...@openoffice.apache.org



Re: Documenting our source code structure

2024-05-16 Thread Damjan Jovanovic
On Thu, May 16, 2024 at 2:41 PM Matthias Seidel 
wrote:

> Hi All,
>
> Some time ago I added some rudimentary Readme to some directories in our
> code, e.g.:
>
> https://github.com/apache/openoffice/edit/trunk/main/sw/README.md
>
> Please feel encouraged to add more information to describe what a
> specific directory is meant for.
>
> Of course, this is a work in progress, but it would help volunteers to
> understand our code better.
>
> In this case, who should know, that "sw" stands for "StarWriter" and
> contains the code for the "Writer" part of our software?
>
> Opinions?
>
>
Please note we already have other sources of info that could be used for
these files, eg. in the  tag of some modules' xml files, such
as main/sw/xml/writer.xml

Regards
Damjan