Skip to content

better docs #15

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

Merged
merged 3 commits into from
Jul 24, 2025
Merged

better docs #15

merged 3 commits into from
Jul 24, 2025

Conversation

masnwilliams
Copy link
Contributor

@masnwilliams masnwilliams commented Jul 22, 2025

TL;DR

Improved the mcp.mdx documentation to enhance new user onboarding with a step-by-step guide and new usage examples.

Why we made these changes

To simplify the initial setup experience for new users, clarify server installation and AI assistant usage, and provide practical deployment examples.

What changed?

  • mcp.mdx: Added a "First Time? Start Here!" section with a step-by-step guide for server installation, AI assistant usage, and deployment. Introduced a "Usage Examples" section for app deployment and invocation. Renamed sections, rephrased setup instructions, simplified Goose installation, and updated FAQ answers for improved clarity.

Validation

  • Reviewed new sections for clarity and accuracy.
  • Verified step-by-step guides are easy to follow.
  • Confirmed usage examples are correct and helpful.

@masnwilliams masnwilliams requested a review from juecd July 22, 2025 19:20
Copy link

@mesa-dot-dev mesa-dot-dev bot left a comment

Choose a reason for hiding this comment

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

What Changed

This PR significantly overhauls the mcp.mdx documentation to improve the new user onboarding experience. Key additions include a 'First Time? Start Here!' section with a step-by-step guide and a new 'Usage Examples' section. The existing content has also been refined for clarity, with simplified installation steps and updated FAQs.

Risks / Concerns

This is a fantastic documentation update with no discernible risks. The changes are well-structured and will significantly improve the onboarding experience for new users. Great work!

1 files reviewed | 0 comments | Review on Mesa | Edit Reviewer Settings

Copy link
Contributor

@juecd juecd left a comment

Choose a reason for hiding this comment

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

Just a couple style comments - this content is awesome!

@masnwilliams masnwilliams requested a review from juecd July 24, 2025 15:21
@masnwilliams masnwilliams merged commit da2d201 into main Jul 24, 2025
1 check passed
@masnwilliams masnwilliams deleted the mason/better-docs branch July 24, 2025 15:31
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