Initial commit

Author: Richy-Z

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalisation
+* text=auto

.github/workflows/publish.yml

@@ -0,0 +1,44 @@
+name: Publish to docs.flex.gd
+on:
+    push:
+        branches:
+            - master
+            - main
+    workflow_dispatch:
+permissions:
+    contents: write
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Configure Git Credentials
+              run: |
+                  git config user.name github-actions[bot]
+                  git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+            - uses: actions/setup-python@v5
+              with:
+                  python-version: 3.x
+              name: Set Cache ID
+            - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+            - uses: actions/cache@v4
+              with:
+                  key: mkdocs-material-${{ env.cache_id }}
+                  path: .cache
+                  restore-keys: |
+                      mkdocs-material-
+            # - name: Build bot and viewer JSON metadata
+            #   run: |
+            #       cd parser
+
+            #       sudo chmod +x ./install.sh
+            #       ./install.sh
+
+            #       luvit main.lua
+
+            #       cd ../
+
+            #       rm -rf parser
+            - run: pip install mkdocs-material
+            - run: pip install -r requirements.txt
+            - run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,20 @@
+# Python venv exclusion for the internal documentation platform
+.venv
+venv
+
+**.bat
+
+# Luvit dependencies
+parser/deps
+
+# metadata api
+docs/built-info
+
+docs/api/
+
+# Local caching
+.cache/
+
+# macOS hidden files
+**._*
+**.DS_*

.markdownlint.json

@@ -0,0 +1,7 @@
+{
+	"MD046": false,
+	"MD013": false,
+	"MD059": false,
+	"MD033": false,
+	"MD010": false
+}

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+  "recommendations": [
+    "redhat.vscode-yaml",
+
+    "JohnnyMorganz.luau-lsp",
+
+    "DavidAnson.vscode-markdownlint",
+    "yzhang.markdown-all-in-one"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,32 @@
+{
+	"yaml.schemas": {
+		"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+	},
+	"yaml.customTags": [
+		"!ENV scalar",
+		"!ENV sequence",
+		"!relative scalar",
+		"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+		"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+		"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
+		"tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
+	],
+	"editor.formatOnSave": true,
+	"editor.formatOnPaste": true,
+	"editor.insertSpaces": false,
+	"editor.tabSize": 4,
+	"[markdown]": {
+		"editor.defaultFormatter": "yzhang.markdown-all-in-one"
+	},
+	"[yaml]": {
+		"editor.defaultFormatter": "redhat.vscode-yaml",
+		"editor.tabSize": 4,
+	},
+	"[json]": {
+		"editor.defaultFormatter": "vscode.json-language-features"
+	},
+	"Lua.diagnostics.globals": [
+		"p"
+	],
+	"stylua.targetReleaseVersion": "latest",
+}

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# 📝 Contribution Guidelines
+
+In order to make the Flex documentation more organised and better for readers, we recommend you follow the contribution guidelines.
+
+Please view the contribution guidelines [here](./docs/About/contributing.md) or via the [Flex Documentation website](https://docs.flex.gd/About/contributing/).

README.md

@@ -0,0 +1,33 @@
+# [Flex Documentation](https://docs.flex.gd)
+
+[![Publish to docs.flex.gd](https://github.com/flex-utilities/docs/actions/workflows/publish.yml/badge.svg)](https://github.com/flex-utilities/docs/actions/workflows/publish.yml)
+
+Welcome to the repository for Flex's online documentation!
+Documentation is hosted at <https://docs.flex.gd> for easily viewing information about the standard on an easy-to-use and beautiful site.
+
+## What is Flex?
+
+Please view the README about Flex at [docs/About/what-is-flex.md](./docs/About/what-is-flex.md) or look at the entire ["About" directory](./docs/About/).
+
+## Contributing
+
+Please make a **PULL REQUEST** with your changes so that they can be reviewed. All pull requests are subject to the [contribution guidelines](./docs/About/contributing.md).
+
+<details>
+<summary>Previewing the documentation site</summary>
+
+If you are working on the documentation and would like a live preview of the site, please use a Python virtual environment (venv).
+
+```sh
+python3 -m venv venv
+```
+
+After which you must install the requirements of the project using `pip`.
+
+```sh
+python3 -m pip install -r requirements.txt
+```
+
+Once all dependencies are installed, you may see a preview of your work using `mkdocs serve`.
+  
+</details>

TODO.md

@@ -0,0 +1,39 @@
+# To-Do List
+
+This to-do list is split up into sections with tasks assigned to documentation maintainers.
+
+## To-Do List for me (Richy)
+
+- cross-reference with old documentation to ensure we arent missing any functions in the new documentation
+- Write a linter for this documentation:
+  - Warn when there is a `code snippet` that doesnt have syntax highlighting applied to it
+  - It should not error when it encounters just one error immediately. errors/warnings for linting must be appended to an array and then printed last. os.exit code shoudl be error if strict errors appended but no os.exit error code if there are only warnings.
+  - Must check when "Lua" is used individually instead of "Luau". also detect "Lua's", etc. because Luau is used, not Lua.
+  - Must check when the long hyphens are used or the non-standard quotes are used (the fancy ones instead of the programmer ones)
+  - add emoji checking, allowing them only on level 3 headings (`###`). nowhere else.
+- ensure there is a luau type definition for the following things:
+  - Drawing object
+- search for code snippets and ensure they have relevant, appropriate links
+- search for "TODO" messages to fix todo items
+
+## Latest to-do list for Richy
+
+- Make a document somewhere under the About section explaining why we dont test some functions from the original UNC, eg "Where is the cache library?"
+  - where are mouse funcs or isrbxactive etc?
+- Potentially note that debug.getinfo is useless as we have better debug.info (just put this note in debug.getinfo, if you still want to implement getinfo then visit this link etc, but otherwise theyre somewhat similar)
+  - "dont really care much about this function, but i think we should add it, since we did add setscriptable"
+- create documentation for `decompile` under SCRIPTS (not reflection!) group, and also every other function mentioned [here](https://github.com/sUNC-Utilities/docs.sunc.su/issues/162)
+  - <https://synapsexdocs.github.io/custom-lua-functions/reflection-functions/#decompile>
+  - cross off items from same github issue
+- cache library, even though it may seem redundant in the meantime (it will be removed in the future from the next version of sUNC)
+  - <https://synapsexdocs.github.io/libraries/syn/>
+  - <https://github.com/unified-naming-convention/NamingStandard/blob/305c31e4f469c056812c9f412c9a4d78293021bc/api/cache.md?plain=1>
+- `debug.getinfo`
+  - <https://github.com/unified-naming-convention/NamingStandard/blob/305c31e4f469c056812c9f412c9a4d78293021bc/api/debug.md?plain=1#L70-L112>
+  - <https://synapsexdocs.github.io/libraries/debug/#get-info>
+- Modify the documentation parser to ignore HTML comments in markdown (so that comments / todo notes dont have to be moved to the very bottom of a markdown file)
+- Document how the Rubiš API can be used (currently) to retrieve information about sUNC test results
+  - note differences about public and private scraps
+  - most test results are private
+  - unfortunately we do not provide a way for the public to know whether a scrap posted on rubis is officially from sUNC, although by popular request we may add an endpoint to give in-depth sunc information (including verified results)
+    - note that rubis results will be deprecated in the future (at least via the regular rubis api) and they will be migrated to the rubis partners api