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.

Sign up for GitHub

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

Jump to bottom

API generation and referencing #1557

Closed
arboleya opened this issue Dec 19, 2023 · 0 comments · Fixed by #1664
Closed

API generation and referencing #1557

arboleya opened this issue Dec 19, 2023 · 0 comments · Fixed by #1664
Assignees
@Torres-ssf
Labels
docs Requests pertinent to documentation
Milestone
2 - Beetle

Comments

@arboleya
Copy link
Member

All referenced types in the written docs should link to a clear, generated API reference in the docs, otherwise it's very difficult to track down what object is being discussed where, and how to find it. This will likely need to be auto-generated but can and should be done.

Note
@arboleya arboleya added the docs Requests pertinent to documentation label Dec 19, 2023
@arboleya arboleya added this to the 3 - Wasp milestone Jan 8, 2024
@Torres-ssf Torres-ssf self-assigned this Jan 17, 2024
@Torres-ssf Torres-ssf mentioned this issue Jan 18, 2024
Merged
@arboleya arboleya modified the milestones: 3 - Wasp, 2 - Beetle Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Torres-ssf Torres-ssf

Labels
docs Requests pertinent to documentation
Projects
None yet
Milestone
2 - Beetle
Development

Successfully merging a pull request may close this issue.

docs: add API ref links FuelLabs/fuels-ts
2 participants
@arboleya @Torres-ssf