Skip to content
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

Building Block APIs Docs Refresh #2420

Closed
10 of 11 tasks
nyemade-uversky opened this issue May 4, 2022 · 2 comments
Closed
10 of 11 tasks

Building Block APIs Docs Refresh #2420

nyemade-uversky opened this issue May 4, 2022 · 2 comments
Assignees
Labels
content/missing-information More information requested or needed

Comments

@nyemade-uversky
Copy link
Contributor

nyemade-uversky commented May 4, 2022

Description:
Current docs for the Building Block APIs could use a refresh. Current docs are a bit stale and could use some edits to bring them up to date. This effort will be done over the course of time as bandwidth becomes available. This issue will serve as a record for which docs have already been updated.

Docs to Refresh:

@sicoyle
Copy link
Contributor

sicoyle commented Sep 21, 2023

@hhunter-ms Can you add a bit more clarity here in terms of what "refresh means" for the docs that need updating so it is clear on the work that needs to be done please.

@hhunter-ms
Copy link
Collaborator

hhunter-ms commented Sep 22, 2023

@sicoyle Sure -

Remaining building block doc sets need a "freshness pass", ie:

  • Any formatting edits to make consistent with other already "freshened up" building block docs
  • General grammar and spelling check
  • Check for accuracy (test how-to docs/code snippets)
  • Make sure docs explain the concept of the building block well enough for a new user; if need more info, talk to devs in discord channels
  • Try adding diagrams to building block overviews that don't currently have one
  • If a demo exists in a Dapr community call for that topic, embed at bottom of relevant doc
  • Cross link so that users can find all info they need on that topic or the appropriate next steps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content/missing-information More information requested or needed
Projects
No open projects
Development

No branches or pull requests

3 participants