From bc86054dbd65df88e8464db08a516cd355ba3ea0 Mon Sep 17 00:00:00 2001 From: mi-hol <22799428+mi-hol@users.noreply.github.com> Date: Fri, 30 Dec 2022 15:54:29 +0100 Subject: [PATCH] fix links and md syntax --- .vscode/settings.json | 1 + HOWTO-ask-questions.md | 39 ++++++++++++++++++--------------------- HOWTO-validate-links.md | 20 +++++++++++++++++++- Home.md | 20 ++++++++------------ 4 files changed, 46 insertions(+), 34 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 495351a4..1a3ec0a0 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -7,6 +7,7 @@ "Avenir", "Baro", "Berlingo", + "BLUF", "CANBUS", "Celica", "DOHC", diff --git a/HOWTO-ask-questions.md b/HOWTO-ask-questions.md index da4a3899..a0e2c925 100644 --- a/HOWTO-ask-questions.md +++ b/HOWTO-ask-questions.md @@ -1,46 +1,43 @@ +# Asking for help + +Before getting in touch for some assistance there are a couple of things to know that will make it easy for us to help you. + +First off before asking for help, please check the rest of the [wiki,](HOWTO-Search-on-rusEFI-wiki.md) Take a look through the [forum](https://rusefi.com/forum)/search.php) or read through the [FAQs.](Pages-FAQ-and-HOWTO) + +If after that you still need direct help then please have a read of the information below and help us to help you. + ## Please post your tune & log files at [rusEFI Online](Online.md). More on that in [Support](Support) --- -# Asking for help - -Before getting in touch for some assistance there are a couple of things to know that will make it easy for us to help you. - -First off before asking for help, please check the rest of the [wiki,](HOWTO-Search-on-rusEFI-wiki.md) Take a look through the [forum]([https://rusefi.com/forum](https://rusefi.com/forum)/search.php) or read through the [FAQs.](Pages-FAQs) - -If after that you still need direct help then please have a read of the information below and help us to help you. - -# Please post details on resolution +## Please post details on resolution Once your issue is resolved please write up how you got things resolved. - -# Persistence +## Persistence [https://rusefi.com/forum](https://rusefi.com/forum) and [https://github.com/rusefi/](https://github.com/rusefi/) are two permanent systems of record for any rusEFI knowledge. rusEFI Slack does NOT keep history. Anything you say on Slack would get hidden after about 15 days. All valuable data and content has to be persisted outside of Slack. -## Please record and post a relevant log file. There are two ways to get a log file: +## Please record and post a relevant log file. There are two ways to get a log file - 1) In TunerStudio, Use "DataLogging">"Start Logging" menu item. Logs are written to Documents\TunerStudioProjects\NAMEOFYOURPROJECT\DataLogs folder. + 1) In TunerStudio, Use "DataLogging">"Start Logging" menu item. Logs are written to "Documents\TunerStudioProjects\NAME_OF_YOUR_PROJECT\DataLogs" folder. 2) With rusEFI console, simply grab the latest .msl file from "out" folder +See also [Knowledge-best-practices-and-Channels](Knowledge-best-practices-and-Channels) -See also [Knowledge-best-practices-and-Channels](Knowledge-best-practices-and-Channels) - -## HOWTO Ask Technical Questions +## HOWTO Ask Technical Questions + +See also [BLUF (bottom line up front) communication](https://en.wikipedia.org/wiki/BLUF_(communication)) -See also https://en.wikipedia.org/wiki/BLUF_(communication) - [How to ask technical questions](https://opensource.com/life/16/10/how-ask-technical-questions) [How To Ask](https://stackoverflow.com/help/how-to-ask) [FreeCAD's Bug Submission Guidelines](https://forum.freecadweb.org/viewtopic.php?f=3&t=5236) - + An example of a question asked with helpful background information: - + [UK Mazda MX5 miata NB 1.8'99 - Future Turbo project r0.5 #38 - Forum](https://rusefi.com/forum/viewtopic.php?f=3&t=1282&start=101) - ![video](FAQ/images/fantastic-story-video-or-it-never-happened.jpg) diff --git a/HOWTO-validate-links.md b/HOWTO-validate-links.md index 9ca80dc6..7ed089ff 100644 --- a/HOWTO-validate-links.md +++ b/HOWTO-validate-links.md @@ -65,4 +65,22 @@ node .\node_modules\markdown-link-validator\dist\src\bin\markdown-link-validator VS Code Extensions "markdownlint" and "Code Spell Checker" have to be installed ![show all rule violations](Images/DevTools/VS Code - show all violations) -![fix all rule violations](Images/DevTools/VS Code - fix all violations) + +![fix all rule violations](Images/DevTools/VS Code - fix all violations.png) + +## find orphaned files + +- mkdocs build + +-create python venv +bash: python3.10 -m venv ~/weborphans_venv + +-switch to venv +ps1: $HOME\Documents\.venv\bin\Activate.ps1 +bash: source ~/weborphans_venv/bin/activate +-run script +ps1: mkdocs build >..\mkdocs.log 2>..\mkdocs.error.log + +```powershell +python3.10 .\wiki-tools\weborphans.py C:\Users\mholzer\Documents\git\rusefi_documentation\mkdocs\site\Home\ https://wiki.rusefi.com/ >.\wiki-tools\weborphans.log +``` diff --git a/Home.md b/Home.md index bf801466..7cc75776 100644 --- a/Home.md +++ b/Home.md @@ -1,12 +1,12 @@ -### Click on the image below for the latest builds and downloads! +# Click on the image below for the latest builds and downloads -[![](Images/Latest_bundle_border.png)](Download) +[![Download](Images/Latest_bundle_border.png)](Download) Hello and welcome! You have found the rusEFI wiki main page. Here you will find information related to rusEFI, a GPL open-source engine control unit for gasoline port-injected internal combustion engines. This project involves embedded hardware, software, and engines (vroom vroom). This community has many members from many walks of life who are scattered all around the world. -**This project is NOT for emissions controlled or safety critical applications. This project is for race cars, snow blowers, fixed engine applications, and science experiments. It is PROHIBITED to use rusEFI on manned aircraft. ** +**This project is NOT for emissions controlled or safety critical applications. This project is for race cars, snow blowers, fixed engine applications, and science experiments. It is PROHIBITED to use rusEFI on manned aircraft.** In order to use rusEFI you will need to acquire or fabricate one of the [supported boards](Hardware). You can also design your own custom board if so desired. @@ -43,20 +43,17 @@ Automatic Transmission Control|✗ [Direct Injection](GDI-status)|✗ [Kick start](Kick-Start)|✗ - - -Achievement| Results +Achievement| Results -------|------------- Hundreds of rusEFI units produced|✓ We've lost track of how many vehicles are running on rusEFI|✓ - And many more! See [rusEFI-project](rusEFI-project) for more details. -The unsupported features listed here are all things that would be amazing to see! IF YOU have a project that includes any of those configurations or anything else, please jump in on the forums and we can work together to make it happen! 👍 +The unsupported features listed here are all things that would be amazing to see! IF YOU have a project that includes any of those configurations or anything else, please jump in on the forums and we can work together to make it happen! 👍 -## Get Started! +## Get Started -So you are thinking of doing an engine control project. You have stopped by the correct place. This rusEFI project has many options that can likely help you out. We have several forum members with a wide variety of skills that are often willing to help people out. As well we have several hardware options. If a feature doesn't exist inquire in the forums and it is likely that we can develop the feature. Or better yet, its an open source project, you can develop it yourself and if you feel like giving something back, you can share it with others. +So you are thinking of doing an engine control project. You have stopped by the correct place. This rusEFI project has many options that can likely help you out. We have several forum members with a wide variety of skills that are often willing to help people out. As well we have several hardware options. If a feature doesn't exist inquire in the forums and it is likely that we can develop the feature. Or better yet, its an open source project, you can develop it yourself and if you feel like giving something back, you can share it with others. [Quick Start](HOWTO-quick-start) @@ -66,11 +63,10 @@ So you are thinking of doing an engine control project. You have stopped by the [Help Out](HOWTO-help-rusEFI) -## rusEFI in action! +## rusEFI in action [Engines running rusEFI](List-of-Engines-Running-rusEFI) ### [![Miata rusEFI Racecar!](https://user-images.githubusercontent.com/5051341/80621997-bf7bf000-8a0d-11ea-998e-48fc3accba59.png)](https://www.youtube.com/embed/3xz66oR95F8?start=8 "Miata rusEFI Racecar!") ### [![BMW V12 with dual ETB!](https://user-images.githubusercontent.com/5051341/80622501-809a6a00-8a0e-11ea-8efc-b575def1d132.png)](https://www.youtube.com/embed/TGf8IMwRuIY "BMW V12 with dual ETB!") -