This repository has been archived by the owner on Mar 4, 2020. It is now read-only.
docs: remove HTML preview and improve error readout #1906
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
levithomason
requested review from
dvdzkwsk,
kuzhelov,
layershifter,
miroslavstastny and
mnajdova
as code owners
Codecov Report
@@ Coverage Diff @@
## master #1906 +/- ##
=======================================
Coverage 69.89% 69.89%
=======================================
Files 890 890
Lines 7785 7785
Branches 2248 2248
=======================================
Hits 5441 5441
Misses 2334 2334
Partials 10 10Continue to review full report at Codecov.
|
miroslavstastny
approved these changes
Sep 9, 2019
layershifter
pushed a commit
that referenced
this pull request
Sep 13, 2019
* docs: remove HTML, improve error readout * docs: add changelog entry (cherry picked from commit 18f35b0)
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Remove Rendered HTML
Our HTML renderer is broken and causing all Portal examples to fail. Users can just use the HTML explorer in the browser. This was chosen as the simplest solution to our issue. It also removes some of the crowding problem that we have in examples by only showing the JSX.
Now our examples all work:
Better Error Experience
Our errors used to get buried and lost below the fold on long examples. A red border was added around the example source code when in error state to let the user know there is an error below. Additionally, the errors are
stickyso that they are always at the bottom of the screen.