rusefi / rusefi_documentation

User documentation for rusEFI engine control unit
GNU General Public License v3.0
25 stars 30 forks source link

requirement to manually sync navigation bar on wiki3 und wiki2 results in inconsistencies #411

Closed mi-hol closed 1 year ago

mi-hol commented 1 year ago

Could the manual process be replaced with automation to avoid this source of error leading to inconsistencies?

i.e. use wiki3 mkdocs.yaml to create wiki2 _Sidebar.md

example of missed requirement is in https://github.com/rusefi/rusefi_documentation/pull/408

chuckwagoncomputing commented 1 year ago

Maybe, but it would be a bit of a mess. You'd have a workflow that committed back to the repo, which would trigger the sync-wiki3 workflow again. I don't think that would really be a problem, but it's an inelegant solution to a small problem.

mi-hol commented 1 year ago

manual edit in Wiki3 required for "boards" section to match wiki2 image

mi-hol commented 1 year ago

address via https://github.com/rusefi/rusefi_documentation/pull/439

mi-hol commented 1 year ago

@rusefillc navigation on Wiki3 misses some Plug&Play boards, should they be added?

wiki2: image

wiki3: image

rusefillc commented 1 year ago

it's a great question if Miata PnP should be added or removed, actually somewhat of a sensitive one. I would prefer to do nothing in this regard now.

mi-hol commented 1 year ago

well I'm only interested to fix a content inconsistency. Currently in Wiki3 (showing 2 Miata models) vs Wiki2 (showing 4 Miata models). Wiki2 is usually considered the "master" therefore the 2 missing models should be added to Wiki3.

mi-hol commented 1 year ago

removing myself as my hands are tied without support