docs: Improve formatting of @fluidframework/counter source-code docs
#11686
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Josmithr
requested review from
tylerbutler,
ChumpChief,
skylerjokiel and
ssimic2
github-actions
bot
added
area: dds
Josmithr
changed the title
@fluidframework/counter source-code docs
Josmithr
commented
Aug 25, 2022
Josmithr
commented
Aug 25, 2022
ssimic2
approved these changes
Aug 30, 2022
|
This commit is queued for merging with the |
WayneFerrao
pushed a commit
to WayneFerrao/FluidFramework
that referenced
this pull request
Aug 31, 2022
microsoft#11686) `@fluidframework/counter` is now promoted more directly on our website, including its API docs. This PR is aimed at cleaning up those docs for public consumption. Mostly simple typo fixes and capitalization/punctuation improvements. But it also moves `SharedCounter`'s summary docs away from using embedded Markdown syntax (which is not supported) toward using `@example` tag syntax for its flow examples.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@fluidframework/counteris now promoted more directly on our website, including its API docs. This PR is aimed at cleaning up those docs for public consumption.Mostly simple typo fixes and capitalization/punctuation improvements. But it also moves
SharedCounter's summary docs away from using embedded Markdown syntax (which is not supported) toward using@exampletag syntax for its flow examples.Additional feedback and suggestions are encouraged!!