git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Feature Idea: Documentation of Project Structure

From
CGChristian Gmx <christian.tallner@gmx.de>
Date
Aug 15, 2022, 01:03 UTC
Message-ID
<2ce1bf38-f2ac-b18e-d246-313fa4ac1428@gmx.de>

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
Message 1 of 1 in “Feature Idea: Documentation of Project Structure”
  1. Christian GmxAug 15, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.