-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
config to default to docs pages as default
- Loading branch information
1 parent
954aa9c
commit 3b4207c
Showing
18 changed files
with
143 additions
and
386 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,46 @@ | ||
| <br /> | ||
|  | ||
|
|
||
| <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) · | ||
| > [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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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<Reflection>} 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'); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.