[task/36875] - Add best practice guide #120
Merged
Conversation
This file contains hidden or 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
|
Docs preview site available at https://quixdocsdev.blob.core.windows.net/prdev/index.html |
SteveRosam
approved these changes
Apr 12, 2023
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.
Description
This PR adds a guide on the Quix documentation best practice. This practice is based around the use of the topic-based writing paradigm, and "docs as code" approach to tooling. Updates to other guides have been made accordingly, sometimes to link to the new guide, and other times to add new guidelines, or clarify existing material.
In summary this PR consists of the following changes:
Internal ticket
Review
This PR does not affect rendered documentation, only support files. Best to view the diff, or see the best practice guide here:
Best Practice Guide