search

Rolisteam / DiceParser

Powerful dice Roller is used as discord bot, irc bot, cli tool and inside Rolisteam : 1d20+4, 1L[head,arm,leg,belly,chest], 1d6+1d8, 8+5*3
http://www.rolisteam.org/
GNU General Public License v3.0
125 stars 31 forks source link

Documentation offer #78

Closed jbirkins closed 4 years ago

jbirkins commented 4 years ago

Hi,

With all respect for coding this stuff, I'm trying to use this bot to play D&D 5e in discord and find the documentation is often confusing and inadequate. I work as a Technical Writer for Oracle and I'd be willing to take a wing at editing the markdown file to make editing corrections and more relevant examples.

obiwankennedy commented 4 years ago

Hi,

Any help is welcomed. The documentation does not move as fast as the code. Currently the project is moving to kde gitlab. It is better if you work from this repositories: https://invent.kde.org/kde/rolisteam-diceparser

Are you familiar with git and gitlab ? Github is less strict about commit. So I need to amend a bit the commit from contributors to be compliant with gitlab rules. So it is less work for me if you go directly on gitlab.

Best regards.

jbirkins commented 4 years ago

I worked in Github for several years while at Microsoft, Oracle uses an internal BitBucket server, so I can probably cope.

Let me take a swipe at making changes on Github. Like you say, updates that would affect the documentation are probably infrequent. If I do a text edit and make the improvements I can see, the maintenance from there might be really light. If it turns into more than two pull requests, I'll move the work to gitlab.

obiwankennedy commented 4 years ago

Basically, if you edit the file from github interface your commit author may be "jbirkins" or "github" and kde gitlab need to have a full defined name on commit author. "J birkins" will work (any two words will do).

obiwankennedy commented 4 years ago

I hope, the gitlab requirement is not too restrictive ? let me know.

Can I close the issue ?

jbirkins commented 4 years ago

go ahead and close the issue. I still feel like the content needs editing, but since I don't seem to have the drive to do it I can't complain too much.