Feedback config in Global Settings page #85
+53
−0
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
rpmccarter
requested changes
Jul 27, 2023
Comment on lines
+432
to
+459
| ### Repo | ||
| <ResponseField name="repo" type="Repo"> | ||
| Specify the repo where you store your source documentations | ||
|
|
||
| <Expandable title="Repo"> | ||
| <ResponseField name="github" type="github_repo"> | ||
| Information about your documentation Github Repo | ||
| <Expandable title="Redirect"> | ||
| <ResponseField name="owner" type="string"> | ||
| </ResponseField> | ||
| <ResponseField name="repo" type="string"> | ||
| </ResponseField> | ||
| <ResponseField name="deployBranch" type="string"> | ||
| The deployment branch name of your documentation | ||
| </ResponseField> | ||
| <ResponseField name="contentDirectory" type="string"> | ||
| The name of the root directory where your documentation is stored in the Github repo | ||
| </ResponseField> | ||
| <ResponseField name="isPrivate" type="boolean"> | ||
| Whether your documentation repo is private. | ||
|
|
||
| Note: if you enabled Suggest Edits or Raise Issue in the feedback section, they would only work if your documentation Github repo is public. | ||
| </ResponseField> | ||
| </Expandable> | ||
| </ResponseField> | ||
| </Expandable> | ||
| </ResponseField> | ||
|
|
There was a problem hiding this comment.
This is a little confusing, but repo isn't actually configured in the mint.json. It's configured somewhere else, not exactly sure where though
Comment on lines
+407
to
+430
| ### Feedbacks | ||
|
|
||
| <ResponseField name="feedback" type="Feedback"> | ||
| Configurations to add a feedback section to the end of every page | ||
|
|
||
| <Expandable title="Redirect"> | ||
| <ResponseField name="suggestEdit" type="boolean"> | ||
| Enable a "Suggest Edit" button that creates an edit to the source documentation in your documentation Github repo, provided that the Github repo is public | ||
|
|
||
| </ResponseField> | ||
| <ResponseField name="raiseIssue" type="boolean"> | ||
| Enable a "Raise Issue" button that creates an issue in your documentation Github repo, provided that the Github repo is public | ||
|
|
||
| </ResponseField> | ||
|
|
||
| </ResponseField> | ||
| <ResponseField name="review" type="boolean"> | ||
| Enable a review section where readers can rate if your document is useful or not | ||
|
|
||
| </ResponseField> | ||
|
|
||
| </Expandable> | ||
|
|
||
| </ResponseField> |
There was a problem hiding this comment.
This section already exists, see line 263, just add to that section
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.
I added some explanations to toggle the feedback section + repo in the global settings page