Skip to content
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

TypeScript imports are not being rendered #233

Closed
petertonysmith94 opened this issue Apr 10, 2024 · 2 comments
Closed

TypeScript imports are not being rendered #233

petertonysmith94 opened this issue Apr 10, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@petertonysmith94
Copy link
Contributor

Related to issue: FuelLabs/fuels-ts#1960

Summary

TypeScript code snippets have import statements, which aren't being rendered correctly (examples below).

  • Docs Hub
    // #import { bn, Contract, FunctionInvocationResult };
  • Fuels-ts Docs
    import { FunctionInvocationResult, Contract, bn } from 'fuels';

The fuels-ts docs has a custom plugin which renders our code snippet imports.

I believe there is work to be done on both repositories, so it would be good to align on this.

Expected

Code snippet imports to be rendered correctly.

e.g. import { FunctionInvocationResult, Contract, bn } from 'fuels';

Actual

Code snippet imports are not rendered.

e.g. // #import { bn, Contract, FunctionInvocationResult };

@sarahschwartz
Copy link
Contributor

I believe I can make this fix on the docs-hub side without any changes in the fuels-ts repo, thanks!

@petertonysmith94
Copy link
Contributor Author

This should be resolved on the Fuels TS side:

Closing issue.

@sarahschwartz sarahschwartz removed their assignment Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants