Skip to content

docs: improve getting started guides and CLI documentation#231

Merged
AmiteK23 merged 2 commits into
mainfrom
docs/getting-started-refresh
Apr 11, 2026
Merged

docs: improve getting started guides and CLI documentation#231
AmiteK23 merged 2 commits into
mainfrom
docs/getting-started-refresh

Conversation

@AmiteK23
Copy link
Copy Markdown
Member

@AmiteK23 AmiteK23 commented Apr 11, 2026

Description

This PR improves the Getting Started and CLI documentation to make onboarding clearer and reduce common setup confusion.

What’s changed

  • Updated installation commands to use the latest npx syntax.
  • Clarified LogicStamp’s relationship to TypeScript and how architectural contracts are derived.
  • Improved the MCP getting started guide with clearer explanations and navigation.
  • Added troubleshooting guidance for npx vs global installs in the CLI docs.
  • Refined .gitignore recommendations and clarified context generation details.

Type of Change

  • Copy update
  • Refactor (docs structure)
  • UI update
  • Bug fix
  • Performance

Preview

None.


Checklist

  • Tested locally (docs build and links)
  • Responsive layout checked
  • Links verified

Additional Notes

These changes aim to reduce friction for first-time users and clarify how the CLI fits into the workflow, especially around installation and context generation.

- update installation commands to use latest npx syntax
- clarify LogicStamp’s relationship to TypeScript contracts
- improve MCP getting started descriptions and navigation links
- add troubleshooting tips for npx vs global CLI installs
- refine .gitignore entries and context generation details
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
logicstamp-dev Ready Ready Preview, Comment Apr 11, 2026 9:10pm

@AmiteK23 AmiteK23 added enhancement New feature or request and removed enhancement New feature or request labels Apr 11, 2026
@AmiteK23 AmiteK23 merged commit b4926e5 into main Apr 11, 2026
4 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.

1 participant