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

[English] Add "Write a ScalarDL Application in Java" tutorial to the sidebar nav; remove error-handling and Asset Proof docs from sidebar nav #708

Conversation

josh-wong
Copy link
Member

Description

This PR adds the new tutorial Write a ScalarDL Application in Java to the sidebar navigation of the English docs. Since that doc includes sections for error handling and Asset Proofs, those docs have been removed from the sidebar navigation.

Note

We're currently creating a Japanese version of the Write a ScalarDL Application in Java tutorial. We'll add that doc and update the sidebar in a different set of PRs.

Related issues and/or PRs

The tutorial Write a ScalarDL Application in Java was added in the following PRs:

Changes made

  • Added the Write a ScalarDL Application in Java tutorial to the sidebars of ScalarDL 3.8, 3.9. and 3.10 (latest), which are under Maintenance Support.
  • Removed the Handle Errors and Use Asset Proofs docs from the sidebars of ScalarDL 3.8, 3.9. and 3.10 (latest), which are under Maintenance Support.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

Since we have links to the error-handling and Asset Proofs docs in other some docs, those two docs will be deleted in a separate PR. We will do that after we have updated those links to point to the error-handling and Asset Proof sections in the tutorial for how to write an application in Java.

These docs are being removed because they have been added to the recently added `Write an Application in Java` doc.
@josh-wong josh-wong added the sidebar navigation Updates to the sidebar navigation label Feb 18, 2025
@josh-wong josh-wong self-assigned this Feb 18, 2025
@josh-wong josh-wong merged commit 64cb89d into main Feb 18, 2025
1 check passed
@josh-wong josh-wong deleted the sidebar-nav/add-write-java-app-doc-remove-error-handling-and-asset-proof-en-us branch February 18, 2025 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sidebar navigation Updates to the sidebar navigation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant