2022-12-28 19:28:56 -08:00
# Documentation Strategy
2022-11-14 07:48:45 -08:00
2022-12-28 19:28:56 -08:00
Open question: What is in scope of rusEFI wiki and what is out of scope?
2022-11-14 07:48:45 -08:00
* 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
2023-01-02 11:22:23 -08:00
* Content problem versus infrastructure/structure problem like < https: // github . com / rusefi / rusefi_documentation / issues / 250 > and < https: // github . com / rusefi / rusefi_documentation / issues / 168 >
2022-11-14 07:49:49 -08:00
* We are probably not trying to teach people how to tune HP Academy does that better
2022-11-14 07:48:45 -08:00
2022-12-28 19:28:56 -08:00
## Wiki status
2022-11-14 07:48:45 -08:00
2022-12-28 19:28:56 -08:00
As of December, 2022 the strategy is to maintain two wikis, with [the same source ](https://github.com/rusefi/rusefi_documentation ) for both.
[https://github.com/rusefi/rusefi/wiki/ ](https://github.com/rusefi/rusefi/wiki/ ) AKA Wiki2
[https://wiki.rusefi.com ](https://wiki.rusefi.com ) AKA Wiki3
2021-11-28 20:37:13 -08:00
2022-12-28 19:28:56 -08:00
Reasons for using a source repo:
2023-01-02 11:22:23 -08:00
2022-12-28 19:28:56 -08:00
1. Access control
2. Change review process
3. History and version control management
2021-11-28 20:37:13 -08:00
2022-12-28 19:28:56 -08:00
Problems with Github Wiki:
2023-01-02 11:22:23 -08:00
2022-12-28 19:28:56 -08:00
1. [Not crawlable by search engines ](https://github.com/isaacs/github/issues/1683 )
2021-11-28 20:37:13 -08:00
2022-12-28 19:28:56 -08:00
Problems with having two wikis:
2023-01-02 11:22:23 -08:00
2022-12-28 19:28:56 -08:00
1. Inconsistency of markup language between the two wikis
2021-11-28 20:37:13 -08:00
2022-12-28 19:28:56 -08:00
See [HOWTO Contribute to Documentation ](HOWTO-contribute-to-documentation )