feat: add intro, quickstart, architecture#837
Open
paulleseute wants to merge 2 commits into
Open
Conversation
First 3 pages of the doc revamp. WIP, since it misses illustration and references to pages that do not exist yet. Reworked the filetree a bit to reflect the table of content.
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
harijoe
approved these changes
Jun 1, 2026
Collaborator
harijoe
left a comment
There was a problem hiding this comment.
Looks neat.
It's worth asking a LLM to review the english to make sure it's 100% natural, but overall very nice
|
|
||
| To get a running codebase right away, you can scaffold a project from our templates. They come pre-configured with: | ||
| - a working MCP server | ||
| - a full development environment with a local emulator, file watching, and hot module reload. |
Collaborator
There was a problem hiding this comment.
Why not using word devtools instead of local emulator?
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
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.
First 3 pages of the doc revamp. WIP, since it misses illustration and references to pages that do not exist yet. Reworked the filetree a bit to reflect the table of content.
Greptile Summary
This PR adds the first three documentation pages of the revamp (
introduction,quickstart, andarchitecture) under a newget-started/directory, and updatesdocs.jsonnavigation accordingly while removing the oldhome.mdx.introduction.mdxandarchitecture.mdxare well-structured with clear explanations, Mermaid sequence diagrams, and working code examples.quickstart.mdxwalks users through scaffold → local dev → tunnel → deploy but has a malformed CodeGroup in the tunnel section (missing closing fence for the npm block) that will break the rendered output for that entire step.docs.jsonnavigation is updated correctly; a/home→/get-started/introductionredirect (flagged in a prior review) is still absent.Confidence Score: 4/5
Safe to merge after fixing the broken CodeGroup fence in quickstart.mdx; the rest of the content is clean.
The tunnel section of quickstart.mdx has a missing closing code fence for the npm block. The CodeGroup will render incorrectly, meaning users following the guide to expose their local server will see garbled or missing instructions rather than a clear command to copy.
docs/get-started/quickstart.mdx — the tunnel CodeGroup around line 69–83 needs the missing closing fence added before the pnpm block.
Comments Outside Diff (1)
docs/docs.json, line 193-222 (link)/homepagedocs/home.mdxhas been removed and its navigation slot replaced byget-started/introduction. Without a corresponding redirect entry, any existing external links, search-engine-indexed URLs, or user bookmarks pointing to/homewill land on a 404. The existing redirects block is the right place to add{ "source": "/home", "destination": "/get-started/introduction" }.Prompt To Fix With AI
Prompt To Fix All With AI
Reviews (2): Last reviewed commit: "Update docs/get-started/quickstart.mdx" | Re-trigger Greptile