There's a neat VSCode extension I recently discovered, CodeTour, that the project ExplainPowerShell utilizes, for instance. I found it very helpful, and made it much easier to understand how everything connects together.
I realize this would be somewhat time-consuming, but even with minimal explanation, it could go a long way towards getting more community support and PRs to help fix issues and make improvements (especially once the support ends), and more direct than explaining in the Wiki since it integrates directly into the editor. Since there are... 19(?) separate CS projects contained in the solution, and even more directories, it can be pretty difficult for a newbie primarily familiar with PS (really talking about myself here...) to wrap one's head around the exact steps necessary to build a given project, since at least some basic familiarity with C#, .NET, TypeScript, Node, VS solution and project structure, plus VS & VSCode extension structure is required to have a working understanding of the repo.
Fortunately, CodeTour directly references files and line numbers to show ordered, in-line explanations, potentially mapping out the circuitous route a given thing takes from start to finish, whether an extension as a whole from its activation trigger to readiness, or a single action like invoking RapidSense on a key press, focusing a view, running a command like the script performance profiler, etc.
At the very least, a tour on how to build each major component would be very helpful, and likely much less of a time commitment than explaining the internals. I realize at least some of this is already documented on the wiki, i.e. the VS Code extension and VS 2022 and 2019 extensions, so it could pretty readily be converted to CodeTour format, just adding file and line references and ideally a bit more verbosity.
The only downside is that references to filenames and lines can become outdated when changes are made, so some minor upkeep would be necessary.
Just an idea!
There's a neat VSCode extension I recently discovered, CodeTour, that the project ExplainPowerShell utilizes, for instance. I found it very helpful, and made it much easier to understand how everything connects together.
I realize this would be somewhat time-consuming, but even with minimal explanation, it could go a long way towards getting more community support and PRs to help fix issues and make improvements (especially once the support ends), and more direct than explaining in the Wiki since it integrates directly into the editor. Since there are... 19(?) separate CS projects contained in the solution, and even more directories, it can be pretty difficult for a newbie primarily familiar with PS (really talking about myself here...) to wrap one's head around the exact steps necessary to build a given project, since at least some basic familiarity with C#, .NET, TypeScript, Node, VS solution and project structure, plus VS & VSCode extension structure is required to have a working understanding of the repo.
Fortunately, CodeTour directly references files and line numbers to show ordered, in-line explanations, potentially mapping out the circuitous route a given thing takes from start to finish, whether an extension as a whole from its activation trigger to readiness, or a single action like invoking RapidSense on a key press, focusing a view, running a command like the script performance profiler, etc.
At the very least, a tour on how to build each major component would be very helpful, and likely much less of a time commitment than explaining the internals. I realize at least some of this is already documented on the wiki, i.e. the VS Code extension and VS 2022 and 2019 extensions, so it could pretty readily be converted to CodeTour format, just adding file and line references and ideally a bit more verbosity.
The only downside is that references to filenames and lines can become outdated when changes are made, so some minor upkeep would be necessary.
Just an idea!