search

YIO-Remote / documentation

📚 YIO Documentation can be found here
GNU General Public License v3.0
24 stars 10 forks source link

Q: How to write and contribute documentation? #1

Closed zehnm closed 4 years ago

zehnm commented 5 years ago

Are there any plans or guidelines about the documentation format?

I'm asking because I started documenting the development setup, buildroot process and everything I come across I'm working on. So far I put all notes in OneNote and then transfer it to MD. My personal preference are wiki pages but I'm open to other formats, as long as it's not Sharepoint ;-)

martonborzak commented 5 years ago

We started using MD files, but open for suggestions regarding documentation. The idea was that we have this repo where we gather and organise all the docs, so it's not scattered all around.

zehnm commented 5 years ago

That makes total sense! Have a look at the GitHub wiki feature. Default format is also MD, but allows for other formats. It makes it much easier to organize and find content. The feature can be enabled in the repo settings.

martonborzak commented 5 years ago

Great! That's cool. I've enabled the wifi feature. Would you be able to start setting that up and creating your doc there? After we have to move all the other stuff too!

zehnm commented 5 years ago

Ok, I will start this week and set something up for an initial review.

martonborzak commented 5 years ago

Sounds good. Thanks!

zehnm commented 4 years ago

I have copied all MD files including their Git history into the wiki:

@martonborzak & @carp3-noctem you have been adding documentation so far: please review if that's the way to go forward.

Next steps IF all agree:

  1. Remove MD files in https://github.com/YIO-Remote/documentation
  2. Slim down README in documentation and reference wiki for the detailed documentation
  3. Continue documentation in wiki (I haven't added my dev setup doc yet)
  4. Standardize naming, organize side bar
martonborzak commented 4 years ago

Sound like a plan. Thanks for moving it over!

On Thu, Oct 17, 2019 at 10:25 PM Markus Zehnder notifications@github.com wrote:

I have copied all MD files including their Git history into the wiki https://github.com/YIO-Remote/documentation/wiki:

-

The wiki can be edited online or checked out and edited offline:

 git clone https://github.com/YIO-Remote/documentation.wiki.git

-

The readme file is used as wiki home (Home.md). Unfortunately I lost the Git history for this file during rename. Sorry about that.

Created an initial simple sidebar (_Sidebar.md).

@martonborzak https://github.com/martonborzak & @carp3-noctem https://github.com/carp3-noctem you have been adding documentation so far: please review if that's the way to go forward.

Next steps IF all agree:

  1. Remove MD files in https://github.com/YIO-Remote/documentation
  2. Slim down README in documentation and reference wiki for the detailed documentation
  3. Continue documentation in wiki (I haven't added my dev setup doc yet)
  4. Standardize naming, organize side bar

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/YIO-Remote/documentation/issues/1?email_source=notifications&email_token=AFQRIUFNG3R67RLPUGLK7F3QPDCZ5A5CNFSM4JBO7CIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBRNCSY#issuecomment-543347019, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFQRIUCBCMGE7254BT5XLETQPDCZ5ANCNFSM4JBO7CIA .

carp3-noctem commented 4 years ago

I'm fine with it. Didn't know the feature yet. Will read through the documentation about git wiki and further on use this.

martonborzak commented 4 years ago

Removed the MD files, closing the issues. Feel free to expand on the README.