forked from rusefi/rusefi
-
Notifications
You must be signed in to change notification settings - Fork 0
Documentation Strategy
rusefillc edited this page Nov 14, 2022
·
4 revisions
Open question what is in scope of rusEFI wiki and what is out of scope.
- A of Nov 2022 the best cost/benefit ratio is to work on TunerStudio layout and TunerStudio field tooltips and help articles which are embedded into "Help" of specific dialogs.
- Andrey does not believe in text documentation on wiki
- Content problem versus infrastructure/structure problem like https://github.com/rusefi/rusefi_documentation/issues/250 and https://github.com/rusefi/rusefi_documentation/issues/168
- We are probably not trying to teach people how to tune HP Academy does that better
As of April, 2020 the strategy is to move from MediaWiki https://rusefi.com/wiki/ to https://github.com/rusefi/rusefi/wiki/
A full list of (Legacy) mediawiki pages is available at https://rusefi.com/wiki/index.php?title=Special:AllPages
Arguments for github:
- Access control
- Better change review process
- Better history and version control management
Arguments against github
- Weird workflow with two separate git repositories
- Weird inconsistency of markup language between two git repositories
Arguments for mediawiki:
- ?
- How to search the Wiki
- Quick Start
- How to ask questions
- Support
- How to create a TunerStudio project
- HOWTOs and FAQs
- rusEFI project overview
- rusEFI Online
- rusEFI virtual simulator
- Fueling
- Multispark
- Cranking
- Electronic Throttle
- Knock Sensing
- Variable Valve Timing
- Lua Scripting
- GDI
- Digital Dash
- rusEFI Hardware Overview
- Wiring & Connectivity Overview
- rusEFI Assembly Completeness Chart
- Kit Instructions
- Hellen Miata 90-95
- Hellen Miata 96-97
- Hellen Miata 99-00
- Hellen Miata 01-05 VVT
- MREAdapter55: from Lada to e30
- Frankenso MazdaMiataNA6 PnP
- Creating a PnP PCB