Skip to content

Update readme#232

Merged
milesziemer merged 1 commit intosmithy-lang:mainfrom
milesziemer:readme
Aug 22, 2025
Merged

Update readme#232
milesziemer merged 1 commit intosmithy-lang:mainfrom
milesziemer:readme

Conversation

@milesziemer
Copy link
Copy Markdown
Contributor

Added installation instructions, feature list, and details on how the server understands your project (including documenting .smithy-project.json). I also added doc comments to the SmithyProjectJson shape.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@milesziemer milesziemer requested a review from a team as a code owner August 21, 2025 16:18
@milesziemer milesziemer requested a review from yashshah41 August 21, 2025 16:18
@milesziemer milesziemer force-pushed the readme branch 2 times, most recently from 0d11fc3 to 305f8b9 Compare August 21, 2025 19:36
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
define sources and dependencies, they will be merged together and de-duplicated.

## Features

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe not needed for now but it might be nice to add image/gifs for these features. Something like: https://github.com/fwcd/kotlin-language-server?tab=readme-ov-file#features

/// List of file or directory paths containing the source Smithy files in
/// the project.
sources: Strings

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should document all of them to be consistent

Copy link
Copy Markdown
Contributor Author

@milesziemer milesziemer Aug 21, 2025

Choose a reason for hiding this comment

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

I left some undocumented here and in the readme because they're extraneous. Added comments in the model

Added installation instructions, feature list, and details on how the
server understands your project (including documenting
.smithy-project.json). I also added doc comments to the
`SmithyProjectJson` shape.
@milesziemer milesziemer merged commit ba8cf3f into smithy-lang:main Aug 22, 2025
3 checks passed
@milesziemer milesziemer deleted the readme branch August 22, 2025 15:18
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