Code Monkey home page Code Monkey logo

Comments (1)

BranDougherty avatar BranDougherty commented on May 12, 2024

Of course all the new systems need to be documented before release, it would be fantastic to get that process started.

Where should documentation be?

The simplest thing is to just use the GitHub wiki, so let's start there. That way we can focus on the 1.8-specific documentation first, and not mix it with the 1.7.1 documentation the community is currently using. Also nontechnical users can still contribute, as long as they are willing to make a GitHub account. It probably wouldn't be too hard to move docs from the GitHub wiki to the soldat.pl wiki via pandoc anyways, I think the most important thing is to just get started.

Also, maybe new documentation could be included in Soldat's releases too?

I'm partial to just a few README files with basic explanations and links to the online documentation myself.

How can people contribute?
It would be good to have some guidelines and information about contributions. It applies both to code and documentation. For example who reviews contributions, and who merges them? Or who takes responsibility for this project and what is the team structure (if any)?

Yes these things are all ambiguous right now, and a CONTRIBUTING.md file is a good solution to that.

from opensoldat.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.