Skip to content

docs: improve onboarding docs#667

Open
RyanClementsHax wants to merge 1 commit intocrbnos:mainfrom
RyanClementsHax:docs/improve-onboarding-docs
Open

docs: improve onboarding docs#667
RyanClementsHax wants to merge 1 commit intocrbnos:mainfrom
RyanClementsHax:docs/improve-onboarding-docs

Conversation

@RyanClementsHax
Copy link
Copy Markdown

What does this PR do?

  • make onboarding docs accurate to what is needed to standup carbon from a clean install
  • update vscode settings to include the auto formatting config
  • make the .env.example file ordered by the env vars we add as we read through the README
  • more documentation is needed to support making novu and AI working locally

Visual Demo (For contributors especially)

A visual demonstration is strongly recommended, for both the original and new change (video / image - any one).

Video Demo (if applicable):

  • Show screen recordings of the issue or feature.
  • Demonstrate how to reproduce the issue, the behavior before and after the change.

Image Demo (if applicable):

  • Add side-by-side screenshots of the original and updated change.
  • Highlight any significant change(s).

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

From a clean install, follow the instructions in the README.md and make sure that the application stands up and works as expected. It is known that more documentation is needed to support make novu:sync work with a local backend.

  • Are there environment variables that should be set? Only those that the instructions say
  • What are the minimal test data to have? None
  • What is expected (happy path) to have (input and output)? The application should stand up, but it is known that more documentation is needed to support other features like AI and novu
  • Any other important info that could help to test that PR

- make onboarding docs accurate to what is needed to standup carbon from a clean install
- update vscode settings to include the auto formatting config
- make the .env.example file ordered by the env vars we add as we read through the README
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 14, 2026

@RyanClementsHax is attempting to deploy a commit to the Carbon Team on Vercel.

A member of the Team first needs to authorize it.

@RyanClementsHax RyanClementsHax marked this pull request as ready for review April 17, 2026 13:43
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