* Feature Idea: Documentation of Project Structure
@ 2022-08-15 1:03 Christian Gmx
0 siblings, 0 replies; only message in thread
From: Christian Gmx @ 2022-08-15 1:03 UTC (permalink / raw)
To: git
When browsing Github repositories, I thought it would be a nice feature
if you could annotate the directories of a project with documentation
comments that explain what is inside the specific directory. If this was
possible with Git, then GUIs like Github or Gitlab could include them.
The idea would be based on Java package Javadoc files which make it
possible to document packages, which I usually do to explain the project
structure.
I think it would be great for OSS, because it would be easy for anybody
who browses a public repo to understand the project structure and maybe
participate without having to read through the documentation.
--
Best Wishes
Christian Tallner
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2022-08-15 1:04 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-08-15 1:03 Feature Idea: Documentation of Project Structure Christian Gmx
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).