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

chore: ship API documentation #3413

Merged
merged 14 commits into from
Nov 21, 2024
Merged

chore: ship API documentation #3413

merged 14 commits into from
Nov 21, 2024

Conversation

danielbate
Copy link
Contributor

@danielbate danielbate commented Nov 20, 2024

Summary

Ships an independent version of our API documentation and exposes more packages in typedoc. In a follow-up PR, we will remove the existing API docs and move the doc links (otherwise CI fails until we've successfully shipped the API docs).

Preview

Screenshot 2024-10-16 at 00 02 09

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

@danielbate danielbate added the chore Issue is a chore label Nov 20, 2024
@danielbate danielbate self-assigned this Nov 20, 2024
Copy link

vercel bot commented Nov 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 9:34am
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 9:34am
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 9:34am

Copy link

codspeed-hq bot commented Nov 20, 2024

CodSpeed Performance Report

Merging #3413 will not alter performance

Comparing db/chore/ship-api-docs (98c7bb7) with master (30585c1)

Summary

✅ 18 untouched benchmarks

@danielbate
Copy link
Contributor Author

Had some issues with the secondary entry points that @petertonysmith94 suggested enabling. It is only a problem in the integrated API docs due to the postbuild script. I will leave them disabled for now, and will reintroduce them once we delete the postbuild script and commit to the isolated API docs.

@danielbate danielbate enabled auto-merge (squash) November 21, 2024 09:41
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
64.2%(+0%) 69.71%(+0%) 72.99%(+0%) 64.64%(+0%)
Changed Files:

Coverage values did not change👌.

@danielbate danielbate merged commit 29f5135 into master Nov 21, 2024
24 checks passed
@danielbate danielbate deleted the db/chore/ship-api-docs branch November 21, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issue is a chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants