Skip to content

feat: add intro, quickstart, architecture#837

Open
paulleseute wants to merge 2 commits into
doc-revampfrom
doc-intro-quickstart-arch
Open

feat: add intro, quickstart, architecture#837
paulleseute wants to merge 2 commits into
doc-revampfrom
doc-intro-quickstart-arch

Conversation

@paulleseute
Copy link
Copy Markdown
Contributor

@paulleseute paulleseute commented May 29, 2026

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, and architecture) under a new get-started/ directory, and updates docs.json navigation accordingly while removing the old home.mdx.

  • introduction.mdx and architecture.mdx are well-structured with clear explanations, Mermaid sequence diagrams, and working code examples.
  • quickstart.mdx walks 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.json navigation is updated correctly; a /home/get-started/introduction redirect (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)

  1. docs/docs.json, line 193-222 (link)

    P1 Missing redirect for deleted /home page

    docs/home.mdx has been removed and its navigation slot replaced by get-started/introduction. Without a corresponding redirect entry, any existing external links, search-engine-indexed URLs, or user bookmarks pointing to /home will 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
    This is a comment left during a code review.
    Path: docs/docs.json
    Line: 193-222
    
    Comment:
    **Missing redirect for deleted `/home` page**
    
    `docs/home.mdx` has been removed and its navigation slot replaced by `get-started/introduction`. Without a corresponding redirect entry, any existing external links, search-engine-indexed URLs, or user bookmarks pointing to `/home` will land on a 404. The existing redirects block is the right place to add `{ "source": "/home", "destination": "/get-started/introduction" }`.
    
    How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
docs/get-started/quickstart.mdx:69-71
The npm code fence opened on line 69 is never closed before the next ` ```bash pnpm ` fence starts on line 71. As written, the raw markdown is malformed — most renderers will either swallow everything through the `</CodeGroup>` tag into a single giant code block or surface a parsing error, leaving users unable to copy the correct tunnel command.

```suggestion
```bash npm
npm run dev -- --tunnel
```
```bash pnpm
```

Reviews (2): Last reviewed commit: "Update docs/get-started/quickstart.mdx" | Re-trigger Greptile

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.
Comment thread docs/get-started/quickstart.mdx Outdated
@paulleseute paulleseute requested review from harijoe and rodincave May 29, 2026 07:10
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Collaborator

@harijoe harijoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not using word devtools instead of local emulator?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants