Users need _current_ feature set - Githubissues

rusefi / rusefi_documentation

User documentation for rusEFI engine control unit

GNU General Public License v3.0

25 stars 30 forks source link

Users need _current_ feature set #111

Open rusefillc opened 3 years ago

rusefillc commented 3 years ago

Problem:

We have

out of date html main page content
wiki feature list
rusEFI online as most accurate capabilities "document"

Also boost and launch are now available we need lists to reflect

rusefillc commented 3 years ago

@ksmola can we improve "in development" icon to be more obvious? maybe shady checkbox?

rusefillc commented 3 years ago

I've promoted Launch and Boost to "working" since we, well, at least have unit tests :)

I've also moved all not supported towards the bottom of lists

Still have a problem of two unrelated lists and manual sync, also wiki does not have "in development" state which www.rusefi.com has, we need a solution probably?

duhafnusa4 commented 3 years ago

Current rusefi.com

Current GH wiki

Looks like rusefi.com needs to be updated. I just wanted to post current status of the 2 pages.

mi-hol commented 1 year ago

@rusefillc should this be closed?

mi-hol commented 1 year ago

source docs:

for GH WIKI is "rusefi_documentation/Home.md"
for rusefi.com seems not available to public ( repo "rusefi/website" is empty)

@rusefillc is this understanding correct? In case it is I'm stuck again.

rusefillc commented 1 year ago

https://github.com/rusefi/website/ is not relevant just deleted it to reduce confusion, thank you for the signal!
https://github.com/rusefi/web_backend is not a great name but that's where rusefi.com is located (inside www folder)

mi-hol commented 1 year ago

source doc for rusefi.com is "web_backend/www/index.html" Is it feasible to reference a md file from repo rusefi_documentation in this source doc?

mi-hol commented 1 year ago

@rusefillc as my question "Is it feasible to reference a md file from repo rusefi_documentation in this source doc?" had no response I plan to add a "test" menu and page to www.rusefi.com.

Is that ok ? or
is there a better approach for trying to reference a md file from repo rusefi_documentation in www.rusefi.com?

mi-hol commented 1 year ago

@rusefillc may I remind about my open question above?

I'll wait for another week, then close in case no answer received

rusefillc commented 1 year ago

I am not aware of any off-the-shelf solutions for this issue.

Some sort of a toolset would need to be created to generate both html and .md from the same feature list which is pretty expensive considering the low priority. looks like manual it would be for now :(

mi-hol commented 1 year ago

well there are several options to solve this issue mentioned in https://lowendtalk.com/discussion/67562/best-way-to-render-markdown-with-nginx and I would suggest to use StrapDown

While I understand the low priority I believe in DRY philosophy and wont waste my time to keep 2 files in sync when a simple solution is already existing. Would using strapdown.js be ok for rusEFI?

rusefillc commented 1 year ago

i am happy to review pull requests. I have nothing against .js.