Code Monkey home page Code Monkey logo

Comments (7)

tsteenbe avatar tsteenbe commented on July 21, 2024 3

I recommend to do the same as many OSS projects - create docs/getting-started as an onboarding guide for this project. I know we are now using a wiki which has a benefits that there easy editable the down side of GitHub wiki is that you can't collaborate easily on them as with commits and pull request discussions.

Should we continue using a GitHub wiki or switch to plain MarkDown files in /docs folder in the repository?

from sharing-creates-value.

HansMKern avatar HansMKern commented on July 21, 2024

Asciidoc or reStructuredText? Markdown is somehow not mature enough for a document and everybody who can write Markdown can write Asciidoc. reStructuredText requires a solid start and a bit of learning.

from sharing-creates-value.

OliverFendt avatar OliverFendt commented on July 21, 2024

In my opinion it is better to have everything in one place, for different reasons like maintainability, completeness and so on. Although I like wikis I think it is better to move the current wiki content to the repo itself.

from sharing-creates-value.

shanecoughlan avatar shanecoughlan commented on July 21, 2024

from sharing-creates-value.

vmbrasseur avatar vmbrasseur commented on July 21, 2024

Wikis are where information goes to die. +1 to @OliverFendt's suggestion to keep everything in one place, and to his stated reasons. Fractured information is lost information,

from sharing-creates-value.

OliverFendt avatar OliverFendt commented on July 21, 2024

Ok fine it seems that we have consensus to move the information from the wiki to the repo and shut down the wiki.
What else shall we do - reorg the repo?

from sharing-creates-value.

OliverFendt avatar OliverFendt commented on July 21, 2024

with the PR #90 it is now time to continue in reorganizing the repo

from sharing-creates-value.

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.