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

docs: Guidance how to write records #2157

Merged
merged 5 commits into from
Mar 7, 2024
Merged

Conversation

eriklimakc
Copy link
Contributor

GitHub Issue (If applicable): closes #

PR Type

What kind of change does this PR introduce?

  • Documentation content changes

What is the new behavior?

Guidance to write proper records with MVUX.

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tested code with current supported SDKs
  • Docs have been added/updated which fit documentation template. (for bug fixes / features)
  • Unit Tests and/or UI Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Wasm UI Tests are not showing unexpected any differences. Validate PR Screenshots Compare Test Run results.
  • Contains NO breaking changes
  • Updated the Release Notes
  • Associated with an issue (GitHub or internal)

Other information

Internal Issue (If applicable):

doc/Learn/Mvux/Tutorials/HowTo-Records.md Outdated Show resolved Hide resolved
doc/Learn/Mvux/Tutorials/HowTo-Records.md Outdated Show resolved Hide resolved
doc/Learn/Mvux/Tutorials/HowTo-Records.md Outdated Show resolved Hide resolved
doc/Learn/Mvux/Tutorials/HowTo-Records.md Outdated Show resolved Hide resolved
doc/Learn/Mvux/Tutorials/HowTo-Records.md Outdated Show resolved Hide resolved
doc/Learn/Mvux/Tutorials/HowTo-Records.md Outdated Show resolved Hide resolved
@eriklimakc eriklimakc requested a review from dr1rrb February 2, 2024 11:54
@nickrandolph
Copy link
Contributor

@eriklimakc for the most part this reads well. However, it's not a how-to as it's not really a step by step set of instructions. I'd suggest renaming this to something like "Working with Records" (or words to this effect) to avoid confusion with the other how-to documentation

@agneszitte
Copy link
Contributor

@agneszitte agneszitte requested a review from nickrandolph March 4, 2024 17:33
doc/Learn/Mvux/WorkingWithRecords.md Outdated Show resolved Hide resolved
doc/Learn/Mvux/WorkingWithRecords.md Outdated Show resolved Hide resolved
@eriklimakc eriklimakc requested a review from dr1rrb March 6, 2024 12:02
@dr1rrb dr1rrb merged commit c9e746e into main Mar 7, 2024
6 of 7 checks passed
@dr1rrb dr1rrb deleted the dev/erli/mvux-howto-records branch March 7, 2024 23:06
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.

4 participants