Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cranking: TunerStudio and documentation out-of-sync #305

Open
mi-hol opened this issue Dec 24, 2022 · 10 comments
Open

Cranking: TunerStudio and documentation out-of-sync #305

mi-hol opened this issue Dec 24, 2022 · 10 comments
Labels
bug Something isn't working content-is-needed

Comments

@mi-hol
Copy link
Contributor

mi-hol commented Dec 24, 2022

image

Requires a technical expert to revise content

i.e. potentially remove content like "As of April 2019 "base fuel pulse" is deprecated, "1" is recommended.

Typical 4 cylinder engine with 200 cc/min injectors, sequential injection, base fuel = 1ms."

@mi-hol mi-hol added bug Something isn't working content-is-needed labels Dec 24, 2022
@mi-hol
Copy link
Contributor Author

mi-hol commented Dec 25, 2022

note: there is a major difference on how the .md is rendered on https://github.com/rusefi/rusefi/wiki/Cranking vs https://wiki.rusefi.com/Cranking/

image

@chuckwagoncomputing
Copy link
Member

There's nothing we can do about the gaps in the images on wiki2. And the only way to make the text flow around it as far as I can tell is to put some in a table like it was before. I thought it was less confusing this way, but if others disagree, I can change it back.

@mi-hol
Copy link
Contributor Author

mi-hol commented Dec 27, 2022

There's nothing we can do about the gaps in the images on wiki2.

This is more of an argument for killing wiki2

I can change it back.

There are many issues on this page anyways (please see in first comment) and #313
Do you use an editor that supports markdownlint?

@chuckwagoncomputing
Copy link
Member

There are many issues on this page anyways (please see in first comment) and #313

I was responding to the things I know about.

Do you use an editor that supports markdownlint?

No

@nmschulte
Copy link
Contributor

There's nothing we can do about the gaps in the images on wiki2.

If we can set style="line-height: 0" or style="font-size: 0" on the <td> wrapping the image-links, the gaps should go away.

@mi-hol
Copy link
Contributor Author

mi-hol commented Dec 28, 2022

There are many issues on this page anyways (please see in first comment) and #313

I was responding to the things I know about.

Do you use an editor that supports markdownlint?

No

May I suggest a trial with VSCode to see the hugh number of issues?
Setup is described in https://github.com/rusefi/rusefi_documentation/blob/master/HOWTO-validate-links.md#using-vs-code-for-markdown-files

@mi-hol
Copy link
Contributor Author

mi-hol commented Dec 28, 2022

set style="line-height: 0" or style="font-size: 0" on the <td> wrapping the image-links, the gaps should go away.

for good reasons markdownlint flags embedded HTML code as problems!
We had already several issues with MkDocs and embedded HTML code.
Instead of adding more problems I would instead remove embedded HTML code as much as possible

@chuckwagoncomputing
Copy link
Member

If we can set style="line-height: 0" or style="font-size: 0" on the <td> wrapping the image-links, the gaps should go away.

Github strips most parameters, including style, from HTML tags.

@chuckwagoncomputing
Copy link
Member

Do you use an editor that supports markdownlint?

No

May I suggest a trial with VSCode to see the hugh number of issues? Setup is described in https://github.com/rusefi/rusefi_documentation/blob/master/HOWTO-validate-links.md#using-vs-code-for-markdown-files

I'm hesitant to use a tool that doesn't understand the nuances of what we are doing. It has already caused problems by telling you to add leading slashes which did not work.

@mi-hol
Copy link
Contributor Author

mi-hol commented Dec 28, 2022

It has already caused problems by telling you to add leading slashes which did not work.

that is incorrect understanding!

MarkdownLint in VSCode will only report the "link not found" type of problem but won't fix it.
The user has to make the fix and it turned out my approach (used in previous projects successfully) was wrong for rusEFI.

My learning was to create #297

My conclusion so far:
We need tooling (i.e. similar to unit tests in firmware development) to find such issues and prevent them from being merged!

I'd love to see input & feedback in above linked issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working content-is-needed
Projects
None yet
Development

No branches or pull requests

3 participants