You can also sue Git without Github. If you have a file server you can
create your own Git depot.
So you can stay entirely offline or local and still benefit from repository
management features and tools if you like.
From: program-l-bounce@xxxxxxxxxxxxx <program-l-bounce@xxxxxxxxxxxxx> On
Behalf Of Lewis Wood
Sent: Friday, April 29, 2022 9:43 AM
To: program-l@xxxxxxxxxxxxx
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
Benefit of collaborating using a repository like GitHub, is your Front End
developer works on a separate branch than you. Merging the branches as
needed.
Front End can remerge bring down master branch into the the branch, thus
resynchronize with your latest features and bug fixes.
Others can download the branch and even you and produce a test version for
your beta testers.
GitHub allows you to generate a private key valid for a specified period and
I believe they allow you can limit their permissions to a certain branch
only.
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of zachtidwell0331@xxxxxxxxx <mailto:zachtidwell0331@xxxxxxxxx>
Sent: Friday, April 29, 2022 7:27 AM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
I haven't been, but I will start now. Are you mentioning GitHub, or a
command-line tool?
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of kperry@xxxxxxxxxxxxx <mailto:kperry@xxxxxxxxxxxxx>
Sent: Thursday, April 28, 2022 8:27 AM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
Are you using a repo system like git. If not you should be. With that said
markdown is still a great way to keep documents.
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of zachtidwell0331@xxxxxxxxx <mailto:zachtidwell0331@xxxxxxxxx>
Sent: Thursday, April 28, 2022 8:56 AM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
It will be private, just so that I can bring my front-end developer up to
speed with my back-end stuff, and to jog my memory in the future if I reuse
any of the systems I've created in future game projects.
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of kperry@xxxxxxxxxxxxx <mailto:kperry@xxxxxxxxxxxxx>
Sent: Wednesday, April 27, 2022 6:26 PM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Re: Creating and maintaining accessible documentation
for code bases
Is this going to be open source or private. If private anything will do.
If open source a lot of times using things like markup works best because
when posting things like a markup file to a site like github it instantly
becomes a web page and is fully accessible.
Ken
From: program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx>
<program-l-bounce@xxxxxxxxxxxxx <mailto:program-l-bounce@xxxxxxxxxxxxx> > On
Behalf Of zachtidwell0331@xxxxxxxxx <mailto:zachtidwell0331@xxxxxxxxx>
Sent: Wednesday, April 27, 2022 6:32 PM
To: program-l@xxxxxxxxxxxxx <mailto:program-l@xxxxxxxxxxxxx>
Subject: [program-l] Creating and maintaining accessible documentation for
code bases
Hey all,
Following-up with my previous inquiry about C#, I've decided that it's time
I create documentation for my code, and that doing so while I'm rewriting my
existing code in C# would be a perfect time to do so.
With that, I'm still very new to programming, so I wanted to ask what you
all use for documenting your code?
