From: Christian Gmx <christian.tallner@gmx.de>
To: git@vger.kernel.org
Subject: Feature Idea: Documentation of Project Structure
Date: Mon, 15 Aug 2022 03:03:56 +0200 [thread overview]
Message-ID: <2ce1bf38-f2ac-b18e-d246-313fa4ac1428@gmx.de> (raw)
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
reply other threads:[~2022-08-15 1:04 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2ce1bf38-f2ac-b18e-d246-313fa4ac1428@gmx.de \
--to=christian.tallner@gmx.de \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).