Skip to content
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

readme setup fixes #827

Merged
merged 1 commit into from
Feb 24, 2025
Merged

Conversation

tippi-fifestarr
Copy link
Collaborator

Description

Made updates to readme file to match my experience of getting it to work (ex: removed prebuild step which errors)

Checklist

  • If any existing pages were renamed or removed:
    • Were redirects added to next.config.mjs?
    • Did you update any relative links that pointed to the renamed / removed pages?
  • Do all Lints pass?
    • Have you ran pnpm fmt?
    • Have you ran pnpm lint?

Copy link

vercel bot commented Feb 24, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
developer-docs-nextra ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 24, 2025 6:32pm

Comment on lines 67 to 79
2. Build Nextra

```bash
npx turbo run build --filter={apps/nextra}...
pnpm run build
```

This will build `apps/nextra` and all local packages it depends on.

3. Navigate to the correct subdirectory

```sh
cd apps/nextra
```

4. Run the development server
3. Run the development server

```sh
pnpm dev
pnpm run dev
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Since the cd apps/nextra step was removed, please specify that these commands should be run from the project root directory. This helps avoid confusion, as running pnpm run build and pnpm run dev from a different directory would fail. Consider either:

  1. Adding a note like "From the project root directory:" before the commands, or
  2. Restoring the cd apps/nextra step

Either approach would prevent a common source of confusion for developers following these instructions.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

@gregnazario gregnazario merged commit 0755fd8 into aptos-labs:main Feb 24, 2025
5 of 6 checks passed
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