{"thread":{"id":"58305","subject":"Feature Idea: Documentation of Project Structure","startedAt":"2022-08-15T01:04:05Z","lastAt":"2022-08-15T01:04:05Z","messageCount":1,"participants":["Christian Gmx"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"461207","messageId":"2ce1bf38-f2ac-b18e-d246-313fa4ac1428@gmx.de","threadId":"58305","inReplyTo":null,"subject":"Feature Idea: Documentation of Project Structure","fromName":"Christian Gmx","fromEmail":"christian.tallner@gmx.de","sentAt":"2022-08-15T01:03:56Z","receivedAt":"2022-08-15T01:04:05Z","isPatch":false,"sender":{"key":"christian.tallner@gmx.de","avatar":null},"body":"When browsing Github repositories, I thought it would be a nice feature\nif you could annotate the directories of a project with documentation\ncomments that explain what is inside the specific directory. If this was\npossible with Git, then GUIs like Github or Gitlab could include them.\nThe idea would be based on Java package Javadoc files which make it\npossible to document packages, which I usually do to explain the project\nstructure.\nI think it would be great for OSS, because it would be easy for anybody\nwho browses a public repo to understand the project structure and maybe\nparticipate without having to read through the documentation.\n\n--\nBest Wishes\n\nChristian Tallner\n\n"}]}