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

docs: segregate api docs url/deployment #3602

Merged
merged 32 commits into from
Feb 8, 2025
Merged

Conversation

nedsalk
Copy link
Contributor

@nedsalk nedsalk commented Jan 21, 2025

Summary

This PR contains the implementation detailed in #3572 (comment).

Once this PR is merged, we should disable the automatic triggering of the docs-api production environment as it'll be reserved for the release workflow to trigger. The nightly environment is being updated on every merge.

Note

When testing out the docs preview of this PR to see if the API is linked properly, opens up a new tab, etc, it might not open up a new tab. Please clear the browser cache and try clicking on the links again.


The related docs-hub PR is

and should be merged before this one to verify that everything works.

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)

@nedsalk nedsalk added the docs Requests pertinent to documentation label Jan 21, 2025
@nedsalk nedsalk self-assigned this Jan 21, 2025
Copy link

vercel bot commented Jan 21, 2025

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 Feb 7, 2025 5:57pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 5:57pm
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 5:57pm

Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple small comments. Nice work @nedsalk 🚀

.github/workflows/release.yaml Show resolved Hide resolved
apps/docs/package.json Show resolved Hide resolved
danielbate
danielbate previously approved these changes Feb 7, 2025
Copy link
Member

@danielbate danielbate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one on the API link validation

scripts/lint-md-links.ts Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Feb 7, 2025

Coverage Report:

Lines Branches Functions Statements
77.15%(+0%) 70.69%(+0%) 75.3%(+0%) 77.15%(+0%)
Changed Files:

Coverage values did not change👌.

@nedsalk
Copy link
Contributor Author

nedsalk commented Feb 8, 2025

Merging this to integrate it with

The comment #3602 (comment) will be resolved by @luizstacio.

@nedsalk nedsalk merged commit 0ab1a4b into master Feb 8, 2025
25 checks passed
@nedsalk nedsalk deleted the ns/fix/api-docs-deployment branch February 8, 2025 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Segregate API docs url/deployment
6 participants