diff --git a/.ls-lint.yml b/.ls-lint.yml index b74aa2fa..741100f8 100644 --- a/.ls-lint.yml +++ b/.ls-lint.yml @@ -31,4 +31,4 @@ ignore: - '**/documentation' - '**/node_modules' - 'apps/docs/.docusaurus' - - 'apps/docs/docs/typedoc' + - 'apps/docs/content/api' diff --git a/README.md b/README.md index 27eb9084..264f703e 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,46 @@ -
+![Hypergiant an Accelint company](assets/banner.jpg) -

- -

+# Development Toolkit (DevTK) -

Accelint Standard Toolkit

- -

The web "standard library" for the Accelint family of systems.

- -
- -> [!IMPORTANT] -> 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.
-> Please read the [contributing guidelines](CONTRIBUTING.md) and the [roadmap](#roadmap-link) of our Technical Steering Committee (TSC). - -
+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: - - - +Development Toolkit (DevTK) is sponsored by: [Hypergiant] (GitHub [@gohypergiant][go]) an [Accelint] company. ---- +## 🔔 Disclaimer -> [Accelint](https://accelint.com)  ·  -> [Hypergiant](https://hypergiant.com)  ·  -> GitHub [@Gohypergiant](https://github.com/gohypergiant)  ·  +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 diff --git a/apps/docs/.gitignore b/apps/docs/.gitignore index 98b7ba05..54823cec 100644 --- a/apps/docs/.gitignore +++ b/apps/docs/.gitignore @@ -7,7 +7,9 @@ # Generated files .docusaurus .cache-loader -docs/typedoc +content/api +content/CONTRIBUTING.md +content/LICENSE.md # Misc .DS_Store diff --git a/apps/docs/README.md b/apps/docs/README.md index a0d34a63..b8220447 100644 --- a/apps/docs/README.md +++ b/apps/docs/README.md @@ -1,4 +1,4 @@ -# Accelint - Standard Toolkit - Documentation Website +# Development Toolkit - Documentation Website This documentation website is built using [Docusaurus](https://docusaurus.io/) and [typedoc](https://typedoc.org/) @@ -37,12 +37,12 @@ See all of the markdown features in docusaurus [here](https://docusaurus.io/docs ### 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 `/docs/typedoc` directory. +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 `/docs/typedoc` directly. To rerun typedoc, run the following command: +> Do not modify content in `/content/api` directly. To rerun typedoc, run the following command: > > ``` > pnpm run build:typedoc @@ -55,7 +55,14 @@ For now, we are using the [@easyops-cn/docusaurus-search-local](https://github.c > [!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 +## 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 a default page in `content/README.md` + - Docs (`docs/` renamed to `content/`) diff --git a/apps/docs/docs/config/another-one.md b/apps/docs/content/config/another-one.md similarity index 100% rename from apps/docs/docs/config/another-one.md rename to apps/docs/content/config/another-one.md diff --git a/apps/docs/docs/packages/demo-ad-hoc-page.md b/apps/docs/content/packages/demo-ad-hoc-page.md similarity index 100% rename from apps/docs/docs/packages/demo-ad-hoc-page.md rename to apps/docs/content/packages/demo-ad-hoc-page.md diff --git a/apps/docs/docs/packages/second-page.md b/apps/docs/content/packages/second-page.md similarity index 100% rename from apps/docs/docs/packages/second-page.md rename to apps/docs/content/packages/second-page.md diff --git a/apps/docs/docusaurus.config.ts b/apps/docs/docusaurus.config.ts index e8f0e734..457ed87f 100644 --- a/apps/docs/docusaurus.config.ts +++ b/apps/docs/docusaurus.config.ts @@ -19,8 +19,9 @@ import rehypeKatex from 'rehype-katex'; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) const config: Config = { - title: 'Accelint Standard Toolkit (DevTK)', - tagline: 'The web "standard library" for the Accelint family of systems.', + title: 'Development Toolkit (DevTK)', + tagline: + 'A "standard library" for web applications in the Accelint family of systems.', favicon: 'img/favicon.ico', url: 'https://gohypergiant.github.io', @@ -30,9 +31,11 @@ const config: Config = { organizationName: 'gohypergiant', projectName: 'standard-toolkit', - onBrokenLinks: 'warn', - onBrokenMarkdownLinks: 'warn', - onBrokenAnchors: 'warn', // for now + // TODO: change "ignore" to "warn" or "error" when the site is more complete. + // "ignore" for now to make the output during build less noisy. + onBrokenLinks: 'ignore', + onBrokenMarkdownLinks: 'ignore', + onBrokenAnchors: 'ignore', // Even if you don't use internationalization, you can use this field to set // useful metadata like html lang. For example, if your site is Chinese, you @@ -47,9 +50,12 @@ const config: Config = { 'classic', { docs: { - sidebarPath: './sidebars.ts', - remarkPlugins: [remarkMath], + breadcrumbs: false, + path: './content', rehypePlugins: [rehypeKatex], + remarkPlugins: [remarkMath], + routeBasePath: '/', + sidebarPath: './sidebars.ts', // Add this to enable the "edit this page" links. // editUrl: 'https://github.com/facebook/docusaurus/tree/main/docs/', }, @@ -64,7 +70,7 @@ const config: Config = { themeConfig: { image: 'img/banner.jpg', navbar: { - title: 'Accelint Standard Toolkit (DevTK)', + title: 'Development Toolkit (DevTK)', items: [ { type: 'docSidebar', diff --git a/apps/docs/lib/typedoc-plugin-hypergiant.mjs b/apps/docs/lib/typedoc-plugin-hypergiant.mjs new file mode 100644 index 00000000..c31aac1e --- /dev/null +++ b/apps/docs/lib/typedoc-plugin-hypergiant.mjs @@ -0,0 +1,57 @@ +/* + * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ + +import { MarkdownPageEvent } from 'typedoc-plugin-markdown'; + +// some files output by TypeDoc are not in the correct location for Docusaurus +// to link them correctly; moving the files is handled by the npm script +function fixLink(page, from, to) { + if (page.contents.includes(from)) { + page.contents = page.contents.replace(from, to); + } +} + +/** + * TypeDoc plugin that customizes the behavior of TypeDoc for our purposes. + * There may be more than one customization in this file and there may be + * additional plugin files for TypeDoc depending on the complexity of the + * needed customization. + * + * @param {import('typedoc').Application} app + * + * @remarks + * pure: no; event handlers are registered on the app + * idempotent: yes + */ +export function load(app) { + app.renderer.off(MarkdownPageEvent.END, renderMarkdown); + app.renderer.on(MarkdownPageEvent.END, renderMarkdown); +} + +/** + * @param {import('typedoc').PageEvent} page + * + * @remarks + * pure: no; mutates page.contents + * idempotent: no; will add the slug to the page.contents each time it is called + */ +function renderMarkdown(page) { + if (page.url === 'README.md') { + // the slug is used by Docusaurus to determine the URL of the page + // in combination with `routeBasePath: '/'` in docusaurus.config.js + // makes the README the index - landing page - page of the site + page.contents = `---\nslug: /\n---\n\n${page.contents}`; + } + + fixLink(page, '_media/CONTRIBUTING.md', 'CONTRIBUTING'); + fixLink(page, '_media/LICENSE', 'LICENSE'); +} diff --git a/apps/docs/package.json b/apps/docs/package.json index c3140bd6..d152400f 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -1,14 +1,15 @@ { "name": "@accelint/docs", - "version": "0.0.1", + "version": "0.1.0", "private": true, "scripts": { - "build:docusaurus": "docusaurus build", - "build:typedoc": "typedoc", "build": "pnpm run build:typedoc && pnpm run build:docusaurus", + "build:docusaurus": "docusaurus build", + "build:contributing": "mv ./content/api/_media/CONTRIBUTING.md ./content/CONTRIBUTING.md", + "build:license": "mv ./content/api/_media/LICENSE ./content/LICENSE.md", + "build:typedoc": "typedoc && pnpm run build:contributing && pnpm run build:license", "clear": "docusaurus clear", - "dev": "docusaurus start", - "docusaurus": "docusaurus", + "dev": "pnpm run build && docusaurus start", "serve": "docusaurus serve" }, "dependencies": { diff --git a/apps/docs/sidebars.ts b/apps/docs/sidebars.ts index cd075449..49e9501c 100644 --- a/apps/docs/sidebars.ts +++ b/apps/docs/sidebars.ts @@ -14,6 +14,8 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) +const TYPEDOC_OUTPUT_DIR = 'api'; + /** * Creating a sidebar enables you to: - create an ordered group of docs @@ -25,17 +27,31 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; Create as many sidebars as you want. */ const sidebars: SidebarsConfig = { - apiSidebar: [{ type: 'autogenerated', dirName: 'typedoc/@accelint' }], - demoSidebar: [ + apiSidebar: [ + { + id: `${TYPEDOC_OUTPUT_DIR}/README`, + label: 'DevTK', + type: 'doc', + }, { + collapsed: false, + label: 'Packages', + items: [ + { dirName: `${TYPEDOC_OUTPUT_DIR}/@accelint`, type: 'autogenerated' }, + ], type: 'category', - label: 'group 1', - items: [{ type: 'autogenerated', dirName: 'packages' }], }, + ], + demoSidebar: [ { + items: [{ type: 'autogenerated', dirName: 'packages' }], + label: 'group 1', type: 'category', - label: 'group 2', + }, + { items: [{ type: 'autogenerated', dirName: 'config' }], + label: 'group 2', + type: 'category', }, ], }; diff --git a/apps/docs/src/pages/CONTRIBUTING.md b/apps/docs/src/pages/CONTRIBUTING.md deleted file mode 100644 index 6952ef6d..00000000 --- a/apps/docs/src/pages/CONTRIBUTING.md +++ /dev/null @@ -1,32 +0,0 @@ -# Contributing to Developer Toolkit - -## If you are an Accelint employee - -1. Setup an ssh key [per the documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). -2. Authorize your ssh key for Hypergiant Github SSO. There is a dropdown for each ssh key that will authorize the token for use with Hypergiant repos. - -## If you are an outside contributor - -1. Fork the repository -2. Make your changes and push to your fork. -3. Open a pull request on this repository from your fork [per the documentiaton](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). - -### Technical Steering Committee - -Developer Toolkit development is governed by the Technical Steering Committee (TSC). Current members: - -- [Bryan Kizer](https://github.com/belsrc) -- [Ray Knight](https://github.com/ArrayKnight) -- [Brandon Pierce](https://github.com/brandonjpierce) - -### Maintainers - -- [Tim McDonald](https://github.com/imtmcdonald) -- [Bryan Kizer](https://github.com/belsrc) -- [Ray Knight](https://github.com/ArrayKnight) -- [Brandon Pierce](https://github.com/brandonjpierce) -- [Brenna Switzer](https://github.com/switzerb) -- [Josh Kalis](https://github.com/kalisjoshua) -- [Teddy Ortega](https://github.com/orteth01) - -Maintainers of the Developer Toolkit have write access to this GitHub repository, and take part in the decision making process. diff --git a/apps/docs/src/pages/LICENSE.md b/apps/docs/src/pages/LICENSE.md deleted file mode 100644 index 261eeb9e..00000000 --- a/apps/docs/src/pages/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/apps/docs/src/pages/index.md b/apps/docs/src/pages/index.md deleted file mode 100644 index 76e5ec83..00000000 --- a/apps/docs/src/pages/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Accelint Standard Toolkit (DevTK) ---- - -

- -

- -

Accelint Standard Toolkit

- -

The web "standard library" for the Accelint family of systems.

- -
- -:::warning -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.
-Please read the [contributing guidelines](CONTRIBUTING) and the [roadmap](#roadmap-link) of our Technical Steering Committee (TSC). -::: - -
- -## 📦 Libraries - -Libraries are exposed via individual packages. Refer to each package documentation for available utilities. - -| Documentation | Package | -| ------------------------------------------|---------------------------- | -| [Constants](/docs/packages/constants) | `@accelint/constants` | -| [Converters](/docs/packages/converters) | `@accelint/converters` | -| [Design System](/docs/packages/design-system) | `@accelint/design-system` | -| [Formatters](/docs/packages/formatters) | `@accelint/formatters` | -| [Geo](/docs/packages/geo) | `@accelint/geo` | -| [Math](/docs/packages/math) | `@accelint/math` | -| [Predicates](/docs/packages/predicates) | `@accelint/predicates` | -| [Temporal](/docs/packages/temporal) | `@accelint/temporal` | -| [Web Worker](/docs/packages/web-worker) | `@accelint/web-worker` | -| [Websocket](/docs/packages/websocket) | `@accelint/websocket` | - - - -We also export configurations for common tooling in our applications. - -| Package | -| ----------------------------- | -| `@accelint/biome-config` | -| `@accelint/eslint-config` | -| `@accelint/prettier-config` | -| `@accelint/typescript-config` | -| `@accelint/vitest-config` | - -## 💡 Contributing - -Read the [contributing guidelines](CONTRIBUTING) file if you are interested in contributing. - -## 🔍 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. - -## 🚀 Attributions - -The Standard Toolkit project is sponsored by: - - - - ---- - -> [Accelint](https://accelint.com)  ·  -> [Hypergiant](https://hypergiant.com)  ·  -> GitHub [@Gohypergiant](https://github.com/gohypergiant)  ·  - diff --git a/apps/docs/static/img/accelint.png b/apps/docs/static/img/accelint.png deleted file mode 100644 index 68d484fb..00000000 Binary files a/apps/docs/static/img/accelint.png and /dev/null differ diff --git a/apps/docs/static/img/banner.jpg b/apps/docs/static/img/banner.jpg deleted file mode 100644 index c043a7a8..00000000 Binary files a/apps/docs/static/img/banner.jpg and /dev/null differ diff --git a/apps/docs/static/img/favicon.ico b/apps/docs/static/img/favicon.ico index c01d54bc..81c2abdb 100644 Binary files a/apps/docs/static/img/favicon.ico and b/apps/docs/static/img/favicon.ico differ diff --git a/apps/docs/typedoc.mjs b/apps/docs/typedoc.mjs index f36ac59f..9ec2c1d5 100644 --- a/apps/docs/typedoc.mjs +++ b/apps/docs/typedoc.mjs @@ -11,15 +11,14 @@ */ /** @type {Partial} */ -const config = { +export default { disableSources: true, entryPoints: ['../../packages/*'], entryPointStrategy: 'packages', - githubPages: false, hideBreadcrumbs: true, hidePageHeader: true, mergeReadme: true, - out: 'docs/typedoc', + out: 'content/api', packageOptions: { entryPoints: ['src/index.ts'], groupOrder: ['Functions', 'Variables', 'Type Aliases', '*'], @@ -28,10 +27,7 @@ const config = { pageTitleTemplates: { member: (args) => args.name, // simpler page titles for member pages }, - plugin: ['typedoc-plugin-markdown'], - readme: 'none', // don't bring in global monorepo readme + plugin: ['typedoc-plugin-markdown', './lib/typedoc-plugin-hypergiant.mjs'], requiredToBeDocumented: ['Class', 'Function', 'Interface'], theme: 'markdown', }; - -export default config;