disneystreaming / disneystreaming/smithy4s
Document smithy-build.json configuration in QuickStart
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 401
- Forks
- 98
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 4
Description
Currently if you start editing the example from the docs, you won't have the protocol definitions pulled in.
Documentation should cover
- What
smithy-build.jsonis for and what can it do - Why this is the minimal required configuration for best editing experience
{
"mavenDependencies": [
"com.disneystreaming.smithy4s:smithy4s-protocol_2.13:latest.stable"
]
}
- What are the possibilities for internal use of this file
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the QuickStart documentation and locate the example that uses smithy-build.json. Read the existing Smithy build configuration guidance, then document the file's purpose, why the shown mavenDependencies entry supports the editing experience, and its internal-use possibilities. Done means all three requested topics and the provided minimal configuration are explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100