docs icon indicating copy to clipboard operation
docs copied to clipboard

Update the SDKs section with language specific and opinionated instructions

Open marcduiker opened this issue 5 months ago • 2 comments

What content needs to be created or modified? Better instructions/examples are needed for all languages on how to get started with Dapr locally. These need to include suggestions for IDEs, extensions, tools and templates, and include instructions for running & debugging applications.

Describe the solution you'd like Structure of Developing applications:

Developing applications
- Languages
  - .NET
    - Visual Studio
    - VS Code
    - Rider
  - Java
    - Eclipse
    - IntelliJ
    - VS Code
   ...

Structure of the new IDE specific page:

  • Intro that describes the content on the page (which tech stacks are recommended for the language)
  • Table on contents
  • Prerequisites for a specific tech stack
  • Scaffolding & setup instructions for tech stack (dependencies & config)
  • Running instructions
  • Debugging instructions
  • Local observability instructions
  • Links to other resources such as Quickstarts / Tutorials

Where should the new material be placed?

  1. Updated pages for all the languages under the Developing applications section. Rename SDKs to Languages.
  2. Provide links from the Getting Started section to the individual language sections.

This is needed for

  • [ ] .NET
  • [ ] Java
  • [ ] Python
  • [ ] Go
  • [ ] JavaScript
  • [ ] PHP
  • [ ] Rust

marcduiker avatar Jul 04 '25 11:07 marcduiker

I captured my thoughts on this in the proposed structure overhaul issue

WhitWaldo avatar Jul 04 '25 13:07 WhitWaldo

More than IDEs I would cover frameworks straight away.

salaboy avatar Jul 05 '25 09:07 salaboy