zeekayandHanzo Dev
e53c106cf2
The first pass left three classes of config that BOTH tsc 5.9 and tsc 7
reject. Each was proven against both compilers before changing:
TS5090 A `paths` target must be relative once `baseUrl` is gone. The
first pass skipped the "./" prefix wherever baseUrl pointed at
the config's own directory, reasoning it was semantically
equivalent. It is not — without baseUrl a non-relative target
is rejected outright, by 5.9 as well as 7.
TS5110 `moduleResolution: node16` requires `module: node16`. The first
pass mapped commonjs projects to node16 resolution alone, which
BROKE those configs for the current toolchain. Both are now set.
TS5102 `downlevelIteration` is also removed in TS7; it was missing from
the dead-flag list.
Verified: repos that tsc 7 previously refused (base-studio, js-sdk, kv-js)
now report zero config errors on tsc 7 AND tsc 5.9.
Co-authored-by: Hanzo Dev <[email protected]>
Runtime Documentation
Report Bug · Join Our Slack · Twitter
The Runtime Documentation is developed with Astro and Starlight. Its core architecture leverages React, while documentation content is authored using Markdown (MDX).
Getting Started
If Node.js or Yarn are installed and set up on your local machine, you can clone this repository and install the required dependencies and configurations:
git clone https://github.com/hanzoai/docs.git
yarn install
Useful Commands
This repository utilizes Yarn to manage project dependencies and custom scripts. Below is a list of commonly used commands, defined in the package.json:
| Command | Action |
|---|---|
yarn dev |
Starts the local development server at localhost:4321. |
yarn build |
Builds the production site to the ./dist/ directory. |
yarn preview |
Previews the production build locally before deployment. |
yarn astro [command] |
Runs Astro CLI commands. |
yarn astro -- --help |
Displays help information for the Astro CLI. |
yarn update-cli-reference |
Updates the Runtime CLI reference using autogenerated CLI documentation. |
yarn update-search |
Updates the Runtime documentation search index. |
yarn update-llms |
Updates the Runtime documentation links index following the /llms.txt standard. |
Documentation Structure
The documentation is organized as .mdx files within the /src/content/docs directory.
Runtime documentation is divided into the following key sections:
-
HomeOverview of Runtime's SDK interfaces and quick start instructions.
-
Getting StartedInstructions for installing Runtime across various environments.
-
ConfigurationGuides to configuring Runtime's core options.
-
ManagementPractical instructions for managing Runtime sandboxes.
-
Agent ToolboxInformation about the File System actions, Git Operations, the Language Server Protocol and Process & Code Execution.
Contributing
Runtime is licensed under the Apache License 2.0. If you would like to contribute to the software, you must:
- Read the Developer Certificate of Origin Version 1.1 (https://developercertificate.org/)
- Sign all commits to the Runtime project.
This ensures that users, distributors, and other contributors can rely on all the software related to Runtime being contributed under the terms of the License. No contributions will be accepted without following this process.
License
This repository contains Runtime's Documentation website, covered under the Apache License 2.0, except where noted (any Runtime logos or trademarks are not covered under the Apache License, and should be explicitly noted by a LICENSE file.)
Runtime is a product produced from this open source software, exclusively by Hanzo Industries, Inc. It is distributed under our commercial terms.
Others are allowed to make their own distribution of the software, but they cannot use any of the Runtime trademarks, cloud services, etc.
We explicitly grant permission for you to make a build that includes our trademarks while developing Runtime itself. You may not publish or share the build, and you may not use that build to run Runtime for any other purpose.
Code of Conduct
This project has adapted the Code of Conduct from the Contributor Covenant. For more information see the Code of Conduct or contact [email protected]. with any additional questions or comments.
Questions
If you need guidance on contributing to Runtime, talk to us on Slack.