-
Notifications
You must be signed in to change notification settings - Fork 49
docs: move docs for telescope repo from docs repo into the telescope #771
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Anmol1696
commented
May 15, 2025
- add gh-action to sync docs back
…add gh-action to sync docs back
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR moves Telescope’s documentation from a separate docs repository into the Telescope repo and adds a GitHub Action to sync the docs back. Key changes include new and updated MDX documentation files for various sections and the addition of a workflow file in .github/workflows/docs.yaml.
Reviewed Changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 7 comments.
Show a summary per file
File | Description |
---|---|
docs/index.mdx | New main documentation file for Telescope. |
docs/get-started.mdx | Adds getting started instructions with code generation, installation, and build tips. |
docs/developing/working-with-asts.mdx | Minor typo fix in the description regarding the npm module usage. |
docs/developing/tree-shakable-hooks.mdx | Updates example code to use the new createGetBalance function; includes minor text changes. |
docs/developing/tests.mdx | Fixes a typo in the test instructions. |
docs/developing/migration.mdx | Fixes spelling mistakes in configuration option descriptions. |
docs/developing/helpers.mdx | Updates documentation text for clarity in describing the addUtil usage. |
docs/developing/creating-new-generators.mdx | Simplifies the generators documentation. |
docs/_meta.json | Adds metadata for the docs structure. |
docs/README.md | Removes the old README as the docs are migrated. |
.github/workflows/docs.yaml | Introduces a new GH Action workflow to sync and deploy the docs. |
# Common helpers or utils | ||
|
||
when generating code, sometimes we need to import helpers, utils or packages. In that case, using addUtil method in context when building ast is recommended, since we only add utils as needed without worrying about repetitive import: | ||
when generating code, sometimes we need to import helpers, utils or packages. In that case, using addUtil method in context when building ast is recommend, since we only add utils as needed without worrying repetitive import: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider improving phrasing: change 'is recommend' to 'is recommended' and 'without worrying repetitive import' to 'without worrying about repetitive imports'.
when generating code, sometimes we need to import helpers, utils or packages. In that case, using addUtil method in context when building ast is recommend, since we only add utils as needed without worrying repetitive import: | |
when generating code, sometimes we need to import helpers, utils, or packages. In that case, using the addUtil method in context when building the AST is recommended, since we only add utils as needed without worrying about repetitive imports: |
Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>