rusefi
/
rusefi_documentation
mirror of https://github.com/rusefi/rusefi_documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

game plan

This commit is contained in:
rusefi 2019-12-30 10:53:14 -05:00
parent aeb6f2ca88
commit 4925af012d
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
FAQ/HOWTO_contribute_to_documentation.md Normal file
View File

@ -0,0 +1,21 @@
# Technical implementation details
Github Wiki is weird.
One the one hand, we have https://github.com/rusefi/rusefi_documentation - that's a git repository with nice pull
request process, but less nice web page rendering which start each folder by showing list of files, that's not what end users want to see.
On the other hand, we have https://github.com/rusefi/rusefi_documentation/wiki which is displayed much nicer - and
that https://github.com/rusefi/rusefi_documentation/wiki is actually implemented by ANOTHER git repository
https://github.com/rusefi/rusefi_documentation.wiki.git behind the scene. That https://github.com/rusefi/rusefi_documentation.wiki.git repository does not have a nice Pull Request process :(
Solution? A combination. Here at rusefi_documentation both repositories are actually set to mirror each other.
This way we have the nice Pull Request process on https://github.com/rusefi/rusefi_documentation and once changes are
merged into https://github.com/rusefi/rusefi_documentation, complete https://github.com/rusefi/rusefi_documentation is merged
into https://github.com/rusefi/rusefi_documentation.wiki.git which makes actual content nicely visible at https://github.com/rusefi/rusefi_documentation/wiki

2
FAQ/HOWTO_help_rusEfi.md
View File

@ -3,6 +3,8 @@
The weakest point of rusEfi is documentation. If you've played with rusEfi for any time chances are you have help improve the documentation.
[Click here for more details](HOWTO_contribute_to_documentation.md)
#### How to contribute to https://github.com/rusefi/rusefi_documentation
Step 1: Sign up or sign in to https://github.com