docs: update documentation and READMEs for atsds-egg implementation - #169
Merged
Conversation
Description This PR updates the project documentation to include details for the newly added atsds-egg package, ensuring both Python (apyds-egg) and TypeScript (atsds-egg) implementations are well-documented. Key Changes: - `/egg/README.md`: Added TypeScript installation steps, a Quick Start example, and build/test instructions. - `/docs/support-packages/egg.md`: Integrated TypeScript usage examples and package links into the main documentation site. - `README.md` (root): Updated the "Support Packages" section to include atsds-egg. - Package Info: Added npm package links and updated repository metadata. These changes ensure that users of the TypeScript binding have clear guidance on how to install and use the E-Graph support package.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the project documentation to include details for the newly added atsds-egg package, ensuring both Python (apyds-egg) and TypeScript (atsds-egg) implementations are well-documented.
Key Changes:
/egg/README.md: Added TypeScript installation steps, a Quick Start example, and build/test instructions./docs/support-packages/egg.md: Integrated TypeScript usage examples and package links into the main documentation site.README.md(root): Updated the "Support Packages" section to include atsds-egg.These changes ensure that users of the TypeScript binding have clear guidance on how to install and use the E-Graph support package.