initial schema docu (#32)

* initial schema docu * update summary * Update src/usage/schema.md Co-authored-by: Josh Soref <[email protected]> * Update src/usage/schema.md Co-authored-by: Josh Soref <[email protected]> * Update src/usage/schema.md Co-authored-by: Josh Soref <[email protected]> * Update schema.md * Update src/usage/schema.md Co-authored-by: Josh Soref <[email protected]> --------- Co-authored-by: Josh Soref <[email protected]>
nektos · Dec 24, 2024 · 75a24b7 · 75a24b7
1 parent 4734813
commit 75a24b7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -15,6 +15,7 @@
   - [Runners](./usage/runners.md)
   - [Custom container engine](./usage/custom_engine.md)
   - [GitHub Enterprise](./usage/github_enterprise.md)
+  - [Schema](./usage/schema.md)
 - [Unsupported functionality](./not_supported.md)
   - [Support matrix]()
   - [Docker context](./missing_functionality/docker_context.md)

diff --git a/src/usage/schema.md b/src/usage/schema.md
@@ -0,0 +1,9 @@
+# Schema
+
+Did you land here because of cryptic errors? Then please install the following official GitHub Actions VSCode Extension https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions and review all errors/warnings shown by it.
+
+
+Once you are sure this is an error in act, please look for existing issues or visit https://github.com/nektos/act/issues/new/choose to report a new issue.
+
+_Act's built-in schema validation errors are not easy to understand while keeping the development effort reasonable for open source._
+