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

Re: Git and Documentation

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Aug 9, 2010, 20:43 UTC
Message-ID
<AANLkTi=pk4oXz84kWbHEzTUiWkTV5P4P9mTwzQbJG865@mail.gmail.com>
In-Reply-To
<AANLkTi=P=RsToSor=giC+dgV24bPj7KJ3eRV1M5a+iuD@mail.gmail.com>
On Mon, Aug 9, 2010 at 17:35, Sultan Shakir <sshakirflhosp@gmail.com> wrote:
Show 7 quoted lines
> Dear Git Community:
> My organization is exploring using Git to manage our code repository.
> We also have a strong need for documentation of our code.  The code is
> written in a proprietary language (Discern Explorer/CCL).  We looked
> into Natural Docs but don't think we can combine it with Git.  Does
> anyone know of an app where we can combine the power of Git and code
> documentation in one?  Thank you. -Sultan
Can you be clearer. That question makes little sense.

You can keep your documentation *in* Git if it's in files that you can keep in version control. So in that case you could keep it alongside your code.

Can't you use this approach?
Previous: Sultan ShakirNext: Sultan Shakir
Message 2 of 7 in “Git and Documentation”
  1. Sultan ShakirAug 9, 2010
  2. Ævar Arnfjörð BjarmasonAug 9, 2010
  3. Sultan ShakirAug 10, 2010
  4. Tomas CarneckyAug 10, 2010
  5. Michael WittenAug 10, 2010
  6. Michael WittenAug 10, 2010
  7. Sultan ShakirAug 11, 2010

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.