docs: add comprehensive README for sample projects #1799
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
Provides overview of all available sample projects, quick start instructions, usage examples, and links to documentation. Previously the README was empty (0 bytes).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds documentation for the sample projects directory (
packages/cli/src/projects/).Problem
The README.md in the samples directory was empty (0 bytes), making it difficult for users to discover and understand available sample projects.
Solution
Created a comprehensive README covering:
elide initelide.pklmanifest formatbuild,test,serve,run)Samples Documented
ktjvmjavamavenjvmcontainersflaskflask-reactweb-static-workerRelates to #1561 (Consistent project samples and gifs)