keep up

.github/workflows/workflow-readme.md

@@ -1,28 +1,45 @@
+
+# Contributions
+- conventions should be
+	- jobs kebab case no caps
+	- step names sentances
+	- step ids snake case
+	- envs all cap snake
+
+
 # Scripts
 
 ## Dev
 Dev Check Test Package TELBlazor.Components Trigger TELBlazor-DevShowCase Deployment
 
-- Run checks
+- Run checks from reeuseable ci checks workflow
+- versions repo and package
 - Artifact and workflow trigger for GH-Page deployment TELBlazor-DevShowCase
-- branch name check logic should be kept upto date with releaserc.json and commitlintrc.json
-- commitlint would be better as a prehook but global gitguardian hook seems to interfere
-- assume git guardian global and prehook
+
 
 ## Pull_Request
+- just runs on all pull requests the Reuseable Ci Checks
 - The pull request, and the branch rules to do the same checks currently. The advantage of the branch rules are that
 they stay in the pull request ui. they are also only targetted on master
 
 
 ## Reuseable Ci Checks
 - Checks should all run so if multiple fails can be resolved in one commit but still trigger a stopping error if any fail at the end of the workflow.
+
 
 ## Release
+- if there is a version change it updates
+	- repo tag
+	- packages with new package and version
+	- TELBlazor-ShowCase site
+
+# Git setup
+
+## Pull requests
+- Branch checks for master (they dont directly use Reuseable Ci Checks instead they use them via the pull_request yml, unsure why not directly available)
+- template needs completing
+- pr reviews rule needs turning on once can get reviewers
 
 # Notes
 - doesnt run easily with nektos act due to git ref checks and calling other workflows
-- conventions should be
-	- jobs kebab case no caps
-	- step names sentances
-	- step ids snake case
-	- envs all cap snake
+

README.md

@@ -22,3 +22,35 @@ It is client side so the users browser will do the work.
 [View Packaged Dev Showcase Code](https://technologyenhancedlearning/TELBlazor-DevShowCase/tree/gh-pages/)
 
 [View Packaged Showcase Code](https://github.com/TechnologyEnhancedLearning/TELBlazor/tree/gh-pages/)
+
+
+# Solution Detail
+
+## Architecture
+
+### Project Structures used
+- Repo TELBlazor
+
+ - TELBlazor.Components
+	- this is a razor component library
+ - TELBlazor.Components.UnitTests
+	- Bunit template from bunit site, configured to use Xunit
+ - TELBlazor.Components.ShowCase.E2ETests
+    - NUnit Playwright Test project
+ - TELBlazor.Components.ShowCase.Shared
+	- this is a razor component library
+ - TELBlazor.Components.ShowCase.E2ETests.WasmServerHost
+	- Wasm global hosted
+ - TELBlazor.Components.ShowCase.E2ETests.WasmServerHost.Client 
+	- Wasm global hosted
+ - TELBlazor.Components.ShowCase.WasmStaticClient
+	- Wasm global standalone 
+
+## Notes
+
+### Stuff you don't need to know (but may be useful for a specific issue on searching the readme)
+- It is not render auto per components because the intention is to be used in MVC views.
+- Xunit is used with Bunit and Nunit with playwright, either could be 
+changed so that they are using the same and this could be done in future 
+as the libraries improve but currently each is being used with the 
+recommend tool it is designed for though both support the others tool.