Documentation - Githubissues

AutumnSpark1226 / ConsoleGame

ConsoleGame is a dungeon game that can be played in a console.

MIT License

0 stars 0 forks source link

Documentation #2

Open AutumnSpark1226 opened 2 years ago

AutumnSpark1226 commented 2 years ago

The documentation is very bad.

internetisaiah commented 2 years ago

@AutumnSpark1226 Hey there! I'd love to help with your documentation. A couple of follow up questions:

What specifically needs the be documented? Is it the "How to" section, currently in WIP state? Or something else?
Who is the audience? I.e. is this internal documentation for yourself and other devs, or is it for end-users?

I look forward to working with you!

AutumnSpark1226 commented 2 years ago

Hi, at the moment the most important thing is the How to section. There should be explained how to play the game (it is a bit difficult to understand at first) and it is for the end users.

AutumnSpark1226 commented 2 years ago

I added the most important information that are required to play the game

internetisaiah commented 2 years ago

Awesome, I'll draft something up and send a PR request on Saturday!

AutumnSpark1226 commented 2 years ago

Great, thank you

internetisaiah commented 2 years ago

Hey @AutumnSpark1226 , I'm about to push up my first draft (still have some sections to work on), but I don't have access to the repo.

What's your policy for contributions? Are you adding people as contributors? Or do you want people to fork the repo and contribute that way?

AutumnSpark1226 commented 2 years ago

Please fork the repo and add a pull request