feat: Documentation Site

.ls-lint.yml

@@ -30,3 +30,5 @@ ignore:
   - '**/dist'
   - '**/documentation'
   - '**/node_modules'
+  - 'apps/docs/.docusaurus'
+  - 'apps/docs/content/api'

README.md

@@ -1,69 +1,46 @@
-<br />
+![Hypergiant an Accelint company](assets/banner.jpg)
 
-<p align="center">
-  <img src="assets/banner.jpg" />
-</p>
+# Development Toolkit (DevTK)
 
-<h1 align="center">Accelint Standard Toolkit</h1>
-
-<p align="center">The web "standard library" for the <a href="https://accelint.com">Accelint</a> family of systems.</p>
-
-<br />
-
-> [!IMPORTANT]
-> Standard Toolkit is currently only intended for usage within the Accelint family of systems.<br>
-> Contributions are more than welcome but please consider that this project may not fit your needs.<br>
-> Please read the [contributing guidelines](CONTRIBUTING.md) and the [roadmap](#roadmap-link) of our Technical Steering Committee (TSC).
-
-<br />
+A "standard library" for web applications in the [Accelint] family of systems.
 
 ## 📦 Libraries
 
-Libraries are exposed via individual packages. Refer to each package documentation for available utilities.
-
-| Documentation                                            | Package                     |
-| ---------------------------------------------------------|---------------------------- |
-| [Constants](./packages/constants/documentation)          | `@accelint/constants`       |
-| [Converters](./packages/converters/documentation)        | `@accelint/converters`      |
-| [Design System](./packages/design-system/documentation)  | `@accelint/design-system`   |
-| [Formatters](./packages/formatters/documentation)        | `@accelint/formatters`      |
-| [Geo](./packages/geo/documentation)                      | `@accelint/geo`             |
-| [Math](./packages/math/documentation)                    | `@accelint/math`            |
-| [Predicates](./packages/predicates/documentation)        | `@accelint/predicates`      |
-| [Predicates](./packages/temporal/documentation)          | `@accelint/temporal`        |
-| [Web Worker](./packages/web-worker/documentation)        | `@accelint/web-worker`      |
-| [Websocket](./packages/websocket/documentation)          | `@accelint/websocket`       |
+Libraries are exposed via individual packages. Refer to the [documentation site][docs] for detailed information.
 
+## 💡 Contributing
 
+Read the [contributing](CONTRIBUTING.md) guidelines file if you are interested in contributing.
 
-We also export configurations for common tooling in our applications.
+## ✨ Versioning
 
-| Package                       |
-| ----------------------------- |
-| `@accelint/biome-config`      |
-| `@accelint/eslint-config`     |
-| `@accelint/prettier-config`   |
-| `@accelint/typescript-config` |
-| `@accelint/vitest-config`     |
+DevTK follows [Semver](https://semver.org/) for versioning of packages to enable consumers to trust what is changing between versions.
 
-## 💡 Contributing
+Given a version number MAJOR.MINOR.PATCH, the meanings of each number changing follows these guidelines:
 
-Read the [contributing guidelines](CONTRIBUTING.md) file if you are interested in contributing.
+- __MAJOR__
+  - Any "breaking" changes; something used to work one way - and therefor consumers might be using a package in that way and thus relying on that functionality - and in the next available version that something now works in a different way
+- __MINOR__
+  - Additional changes; adding functionality, enhancing/extending (without changing) existing functionality
+- __PATCH__
+  - Fixing problems; making something work that should have worked but don't
+  - Adding documentation to better explain what is available
+  - Improved testing to make the expectations more explicit and automatically tested
 
 ## 🔍 License
 
-Published under the [Apache License v2.0](https://www.apache.org/licenses/LICENSE-2.0) license. Read the [license instructions](LICENSE) if you are interested in contributing or using the Standard Toolkit.
+Licensed under [Apache] License v2.0. Read the [license instructions](LICENSE) if you are interested in contributing or using any of the packages.
 
 ## 🚀 Attributions
 
-The Standard Toolkit project is sponsored by:
-
-<a href="https://accelint.com" target="_blank"><img src="assets/accelint.png" height="48" /></a>
-<a href="https://hypergiant.com" target="_blank"><img src="assets/hypergiant.png" height="48" /></a>
+Development Toolkit (DevTK) is sponsored by: [Hypergiant] (GitHub [@gohypergiant][go]) an [Accelint] company.
 
----
+## 🔔 Disclaimer
 
-> [Accelint](https://accelint.com) &nbsp;&middot;&nbsp;
-> [Hypergiant](https://hypergiant.com) &nbsp;&middot;&nbsp;
-> GitHub [@Gohypergiant](https://github.com/gohypergiant) &nbsp;&middot;&nbsp;
+Standard Toolkit is currently only intended for usage within the Accelint family of systems. Contributions are more than welcome but please consider that this project may not fit your needs.
 
+[Accelint]: https://accelint.com
+[Apache]: https://www.apache.org/licenses/LICENSE-2.0
+[docs]: https://gohypergiant.github.io/standard-toolkit
+[go]: https://github.com/gohypergiant
+[Hypergiant]: https://hypergiant.com

apps/docs/.gitignore

@@ -0,0 +1,23 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+content/api
+content/CONTRIBUTING.md
+content/LICENSE.md
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

apps/docs/README.md

@@ -0,0 +1,68 @@
+# Development Toolkit - Documentation Website
+
+This documentation website is built using [Docusaurus](https://docusaurus.io/) and [typedoc](https://typedoc.org/)
+
+## Up and running
+
+### Installation
+
+```
+pnpm install
+```
+
+### Local Development
+
+```
+pnpm run dev
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+> [!WARNING]
+> other packages must be built for the docs site to work correctly. be sure to run the global build script.
+
+### Build
+
+```
+pnpm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Features
+
+### Robust markdown support
+
+See all of the markdown features in docusaurus [here](https://docusaurus.io/docs/markdown-features)
+
+### JSDoc parsing via typedoc
+
+We use [typedoc](https://typedoc.org/) to generate documentation from comments and markdown documents within our packages. Those generated docs live in the `/content/api` directory.
+
+the [autogenerated](https://docusaurus.io/docs/sidebar/autogenerated) docusaurus feature makes integrating the typedoc output into the site very straightforward.
+
+> [!WARNING]
+> Do not modify content in `/content/api` directly. To rerun typedoc, run the following command:
+>
+> ```
+> pnpm run build:typedoc
+> ```
+
+### Search
+
+For now, we are using the [@easyops-cn/docusaurus-search-local](https://github.com/easyops-cn/docusaurus-search-local#readme) library. If/when we outgrow a local search approach, we can explore other options like [Algolia DocSearch](https://docsearch.algolia.com/), which is recommended in the [docusaurus search docs](https://docusaurus.io/docs/search)
+
+> [!NOTE]
+> Local search does not work in dev mode. the search index is created at build time. to test search locally, you can run the `build` script followed by the `serve` script
+
+## Potential Future Features
+
+- [i18n](https://docusaurus.io/docs/i18n/introduction)
+- [blog](https://docusaurus.io/docs/blog)
+
+# Notes
+
+- There are three Docusaurus groupings that can house content: pages (can NOT have a sidebar), docs, and blog. We will primarily use docs as our content organization grouping strategy in Docusaurus.
+  - Pages (src/pages)
+    - Highest priority for resolution, it seems, because with the default page set to `content/README.md` if `src/pages/index.md` exists `content/README.md` will not be displayed as the landing page
+  - Docs (`docs/` renamed to `content/`)

apps/docs/biome.json

@@ -0,0 +1,12 @@
+{
+  "extends": [
+    "@accelint/biome-config/analyzer",
+    "@accelint/biome-config/formatter",
+    "@accelint/biome-config/linter"
+  ],
+  "files": {
+    "include": ["**/*.js", "**/*.mjs", "**/*.ts", "**/*.tsx", "**/*.json"],
+    "ignore": ["node_modules", ".turbo", "dist", "coverage"]
+  },
+  "linter": {}
+}

apps/docs/content/config/another-one.md

@@ -0,0 +1,3 @@
+# Another one
+
+<img src="https://us-tuna-sounds-images.voicemod.net/0bca0bc3-909b-42f4-86f2-0e8b7805b7ee-1714420551465.png" />

apps/docs/content/packages/demo-ad-hoc-page.md

@@ -0,0 +1,57 @@
+# Demo
+
+See the [docusaurus docs](https://docusaurus.io/docs/markdown-features) for full feature set.
+
+## general markdown bidniz
+
+|table|demo|
+|-|-|
+|sweet|potato|
+
+1. yay
+1. cool
+1. wowee
+1. very awesome nice
+
+## code sample
+
+```ts title="highlight demo" showLineNumbers
+// some other thing and stuff
+// some other thing and stuff
+// highlight-next-line
+type Day = 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday';
+// some other thing and stuff
+// some other thing and stuff
+// some other thing and stuff
+```
+
+## live playground
+
+```jsx live
+function Clock(props) {
+  const [date, setDate] = useState(new Date());
+  useEffect(() => {
+    const timerID = setInterval(() => tick(), 1000);
+
+    return function cleanup() {
+      clearInterval(timerID);
+    };
+  });
+
+  function tick() {
+    setDate(new Date());
+  }
+
+  return (
+    <div>
+      <h2>It is {date.toLocaleTimeString()}.</h2>
+    </div>
+  );
+}
+```
+
+## KaTeX
+
+$$
+I = \int_0^{2\pi} \sin(x)\,dx
+$$

apps/docs/content/packages/second-page.md

@@ -0,0 +1,3 @@
+# Second Page
+
+Cool beans