oscarpilote / Ortho4XP

A scenery generator for the X-Plane flight simulator
504 stars 206 forks source link

Idea for creating/improving documentation and a dev branch #262

Open shred86 opened 5 months ago

shred86 commented 5 months ago

First off, thank you for the amazing tool @oscarpilote. It certainly transforms the X-Plane experience and it's something I hope more users are able to utilize. I'm fairly new to Ortho4XP and one thing I found very time consuming was understanding how to set it up and use it. Additionally, I realize this is just a side project for you and obviously not your full-time job, so managing this repository and tool can be a challenge. That being said, that's the reason I wanted to propose these ideas to you.

Github Wiki Documentation

Can we enable the Wiki for this repository and maybe allow a couple of us create and maintain documentation? I've actually already started this on my forked repo, which you can see here. The intent of this Wiki would be to serve as the official Ortho4XP guide and it would be written with a few goals in mind:

  1. Organized such that it's easy for an average user to figure out how to get up and running with fairly minimal effort.
  2. At the same time, provide sections that provide advanced topics for users that want to dive deeper into Ortho4XP.
  3. Cover common or frequently asked questions.

How I have it organized on my forked repo is just an example of how I thought it could be laid out to make it clear and easy to follow.

Create a dev branch

There's obviously been forked branches as well as pull requests to this branch that sit for a while. While I don't think we necessarily should try to combine everything, I do think there's probably areas where some of us can help with fixing bugs, cleaning up code and adding some basic functionality. This could also be managed by a few of us with the intent that the master branch would be the "official" version, but the dev branch allows us to managing inputs from the community such that when you have time to make updates, hopefully it's much easier for you to compare across the two branches and incorporate whatever changes you end up deciding should be in the "official" version.

GitHub Discussions

This is also something else we could enable for this repo not to replace the X-Plane.org forum, but to provide a medium for those of us that want to help maintain this repository (e.g. discussions such as this one).