Updated deployment notes #45
Merged
Conversation
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
Added deployment notes about entrypoint file and dependency manifest to the Deploy CLI section + Deploy guide page.
![mesa-dot-dev[bot]](https://avatars.githubusercontent.com/in/1050077?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Performed full review of c99befd...6c8e894
Tip
⚡ Quick Actions
This review was generated by Mesa.
Actions:
Slash Commands:
/review- Request a full code review/review latest- Review only changes since the last review/describe- Generate PR description. This will update the PR body or issue comment depending on your configuration/help- Get help with Mesa commands and configuration options
2 files reviewed | 1 comments | Review on Mesa | Edit Reviewer Settings
dprevoznik
deleted the
danny/kernel-317-docs-clarify-deployment-directory-requirements
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added deployment notes about entrypoint file and dependency manifest to the Deploy CLI section + Deploy guide page.
Testing
mintlify devworks (see installation here)Visual Proof
TL;DR
Clarified documentation for deployments, adding notes that an entrypoint file (e.g.,
index.js) and a dependency manifest (e.g.,package.json) are required.Why we made these changes
The previous documentation was unclear about the required file structure for a deployment directory. This led to user confusion and failed deployments. These changes explicitly state the requirements to ensure a smoother developer experience.
What changed?
apps/deploy.mdx: Added a note to the main deployment guide clarifying the file requirements.reference/cli/apps.mdx: Added a similar note to the CLI reference documentation for thedeploycommand.Description generated by Mesa. Update settings