Skip to content

docs: Added Docs/feature/getting-started section#48

Merged
Dancode-188 merged 4 commits into
Dancode-188:mainfrom
totalconsciousness:feature/getting-started
May 4, 2026
Merged

docs: Added Docs/feature/getting-started section#48
Dancode-188 merged 4 commits into
Dancode-188:mainfrom
totalconsciousness:feature/getting-started

Conversation

@totalconsciousness

Copy link
Copy Markdown
Contributor

Wrote the Getting Started guide that covers installation, sending a first request, and a "Common Pitfalls & Solutions" section to help new users get started quickly. Included screenshots.

@totalconsciousness

Copy link
Copy Markdown
Contributor Author

@Dancode-188 Hi Daniel, if you have any comments or feedback on my PR, just let me know. Thanks!

@Dancode-188 Dancode-188 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Hey @totalconsciousness, sorry for the delay on this, and thank you for tackling the getting-started guide! The Node.js pitfalls section and the local-first explanation are exactly the kind of practical knowledge that saves new users real frustration. Good work overall.

Two things to address before we merge:

  1. Add the actual installation commands

The steps currently read as prose. Please expand them to include the commands directly, like:

# Clone the repository
git clone https://github.com/Dancode-188/restbolt.git
cd restbolt

# Install dependencies
npm install

# Start the development server
npm run dev

Then open http://localhost:3000 in your browser.
  1. Remove the unused screenshots

The following files are included in the PR but not referenced anywhere in quick-start.md, please remove them to keep the repo clean:

  • Screenshot 2026-03-03 at 5.14.26 PM.png
  • Screenshot 2026-03-09 at 7.41.45 AM.png
  • Screenshot 2026-03-15 at 11.57.36 AM.png
  • Screenshot 2026-03-15 at 12.23.26 PM.png
  • image.png
  • 2026-03-15-13-08-40.png

Also, if you can add descriptive alt text to the images (e.g. RestBolt empty interface) and a newline at the end of the file, that'd be great but those are minor and won't block the merge.

Once the two main items are addressed I'll get this merged right away.

@totalconsciousness

Copy link
Copy Markdown
Contributor Author

Hey @Dancode-188, I just incorporated edits to those main items. Thanks for the feedback!

@Dancode-188 Dancode-188 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks @totalconsciousness for the updates, the alt text, removed screenshots, and added commands all look good. Merging this in!

@Dancode-188 Dancode-188 merged commit c4e62fe into Dancode-188:main May 4, 2026
2 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