Improve documentation sidesheet #9724
Merged
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
juliachvyrova
changed the title
github-actions
bot
added
area/frontend
area/platform
timroes
reviewed
Feb 3, 2022
| const { data: docs, isLoading } = useDocumentation(documentationUrl); | ||
|
|
||
| const removeBaseUrl = (url: { path: string }) => { | ||
| if (url.path.match(/^..\/..\/.*/)) { |
There was a problem hiding this comment.
❓ Could you give an example of what URLs we're trying to rewrite here? This currently matches everything beginning with two arbitrary letters than slash then two more arbitrary letters? My feeling of gut is we're trying to rewrite specifically ../../ URLs here (in which case the dots would need to be escaped in the regex). Also if that's the case we could improve this by simply using startsWith, which is a bit more performant, and easier to read than /^\.\.\/\.\.\/.* :)
There was a problem hiding this comment.
Good catch! Fixed
timroes
reviewed
Feb 3, 2022
| @@ -49,6 +49,14 @@ task copyDocs(type: Copy) { | |||
| duplicatesStrategy DuplicatesStrategy.INCLUDE | |||
| } | |||
|
|
|||
| task copyAssets(type: Copy) { | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
jrhizor
approved these changes
Feb 3, 2022
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.
What
Fixes #8411
Update styles for Documentation Setup Guide sidesheet
Remove html comments
Improve tables
Use colors from app theme
Fix font for titles (h1, h2) and bold text
Improve links