-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Docs: rewrite quickstart as a step-by-step tutorial #1452
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
Merged
Merged
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
3f63963
docs: rewrite quickstart as a step-by-step tutorial
anthonyiscoding 971af87
chore: quickstart text nits
anthonyiscoding 97ff5c6
chore: quickstart text nits
anthonyiscoding 888b3e0
chore: update docs, new command syntax, move install to own page
anthonyiscoding ee2b43e
Update docs/quickstart.mdx
anthonyiscoding 6ee1d04
nit: quickstart docs intro fix
anthonyiscoding aa2f61c
add: state and http workers to quickstart
anthonyiscoding a5605c5
nit: fix how to start/stop workers in quickstart
anthonyiscoding de06899
nit: add -> start for restarting in quickstart
anthonyiscoding 41e3bb6
nit: docs skills install command
anthonyiscoding 8289c6a
nit: docs update console instructions quickstart
anthonyiscoding 0e1888b
nit: terminal opening notes
anthonyiscoding 3549d41
nit: add dependency install delay tip to quickstart step 4
anthonyiscoding d51e755
nit: code change
anthonyiscoding d33efbc
nit: code formatting and remove unnecessary trigger
anthonyiscoding 538a202
fix: http response format bug
anthonyiscoding 0bdc629
nit: replace ASCII architecture diagram with Mermaid
anthonyiscoding c7f92c6
nit: cleanup http response
anthonyiscoding edcdf49
Merge branch 'main' into chore/quickstart-0.11-docs
anthonyiscoding 487ea66
fix: architecture diagram
anthonyiscoding 43ec2e4
nit: architecture diagram
anthonyiscoding e3c1473
docs: add GitHub and Install buttons to navbar
rohitg00 3b16e7f
docs: fix navbar button colors for light and dark mode
rohitg00 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: 'Install' | ||
| description: 'Install the iii engine and set up your development environment.' | ||
| --- | ||
|
|
||
| ## 1. Install iii | ||
|
|
||
| Install the iii engine: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://install.iii.dev/iii/main/install.sh | sh | ||
| ``` | ||
|
|
||
| ## 2. Verify installation | ||
|
|
||
| Check that iii has installed correctly with the following command. It should return a version number. | ||
|
|
||
| ```bash | ||
| iii --version | ||
| ``` | ||
|
|
||
| ## 3. Add Agent Skills (Optional) | ||
|
|
||
| Give your IDEs and AI coding agents full context on iii: | ||
|
|
||
| ```bash | ||
| npx skillkit add iii-hq/iii/skills | ||
| ``` | ||
|
|
||
| ## Next Steps | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Quickstart" href="/quickstart" icon="terminal"> | ||
| Follow the Quickstart and explore a live iii application. | ||
| </Card> | ||
| <Card title="Concepts" href="/primitives-and-concepts" icon="table-layout"> | ||
| Understand Functions and Triggers from a conceptual point of view. | ||
| </Card> | ||
| </CardGroup> |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.