You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Past versions have been tacked together locally, leading to inconsistent results. This first step's goal is to avoid any configuration changes for the rest of the library's processes, while covering most of the exports mentioned in the readme and the Sanity docs. This PR does not add new annotations or address any internal-flagged items that should be public. Those will be addressed once this workflow is up and running.
Core parts:
Typedoc config
New workflow to build + publish to Sanity when a new release goes out.
What to review
Ensure the new upload-docs workflow makes sense with the repo's existing processes.
Testing
The docs:build command will output a JSON file to /docs. If it builds without errors, everything should be fine (warnings are okay).
Next steps: Take a moment to review the security alert above. Review
the linked package source code to understand the potential risk. Ensure the
package is not malicious before proceeding. If you're unsure how to proceed,
reach out to your security team or ask the Socket team for help at
support@socket.dev.
Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code.
Mark the package as acceptable risk. To ignore this alert only
in this pull request, reply with the comment
@SocketSecurity ignore npm/markdown-it@14.1.0. You can
also ignore all packages with @SocketSecurity ignore-all.
To ignore an alert for all future pull requests, use Socket's Dashboard to
change the triage state of this alert.
The TypeDoc JSON file has been generated and validated. All documentation scripts completed successfully.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds support to get client officially into https://reference.sanity.io.
Past versions have been tacked together locally, leading to inconsistent results. This first step's goal is to avoid any configuration changes for the rest of the library's processes, while covering most of the exports mentioned in the readme and the Sanity docs. This PR does not add new annotations or address any internal-flagged items that should be public. Those will be addressed once this workflow is up and running.
Core parts:
What to review
Testing
docs:buildcommand will output a JSON file to/docs. If it builds without errors, everything should be fine (warnings are okay).